aboutsummaryrefslogtreecommitdiffstats
path: root/extra
diff options
context:
space:
mode:
authorBryan Newbold <bnewbold@robocracy.org>2019-02-05 12:44:48 -0800
committerBryan Newbold <bnewbold@robocracy.org>2019-02-05 12:44:48 -0800
commit034da6e42bc6cc3dae3bc94b32df977aa4eac829 (patch)
tree48d9c4e878968c5e04f0b352c78a731541e1dff2 /extra
parentd08f8660637d410b3baa029acd3bab7eb6e8e71e (diff)
downloadfatcat-034da6e42bc6cc3dae3bc94b32df977aa4eac829.tar.gz
fatcat-034da6e42bc6cc3dae3bc94b32df977aa4eac829.zip
start of README files for item uploads
Diffstat (limited to 'extra')
-rw-r--r--extra/sql_dumps/README.md17
-rw-r--r--extra/sql_dumps/ia_exports_item_readme.md5
-rw-r--r--extra/sql_dumps/ia_sqldump_item_readme.md4
3 files changed, 26 insertions, 0 deletions
diff --git a/extra/sql_dumps/README.md b/extra/sql_dumps/README.md
index 4d420190..ee2caa0d 100644
--- a/extra/sql_dumps/README.md
+++ b/extra/sql_dumps/README.md
@@ -69,3 +69,20 @@ replace the `fatcat_prod` database name.
sudo -u postgres pg_dump --verbose --format=tar --exclude-table-data=auth_oidc fatcat_prod | pigz > /srv/fatcat/snapshots/fatcat_public_dbdump_${DATESLUG}.tar.gz
Can also run using the remote/SSH options above.
+
+## Uploading to Internet Archive
+
+The `./ia_item_exports_readme.md` and `sqldump` files should be included as a
+`README.md` when appropriate:
+
+ ia upload fatcat_bulk_exports_YYYY-MM-DD ia_item_exports_readme.md --remote-name=README.md
+ ia upload fatcat_sqldump_full_YYYY-MM-DD ia_item_sqldump_readme.md --remote-name=README.md
+
+Metadata should be set as:
+
+- item name: `fatcat_bulk_exports_YYYY-MM-DD` or `fatcat_sqldump_public_YYYY-MM-DD` (or sometimes `sqldump_full`)
+- collection: `ia_biblio_metadata`
+- creator: `Internet Archive Web Group`
+- date: that the dump started (UTC)
+- title: "Fatcat Bulk Metadata Exports (YYYY-MM-DD)" or "Fatcat Public Database Snapshot (YYYY-MM-DD)"
+
diff --git a/extra/sql_dumps/ia_exports_item_readme.md b/extra/sql_dumps/ia_exports_item_readme.md
new file mode 100644
index 00000000..b61e82f3
--- /dev/null
+++ b/extra/sql_dumps/ia_exports_item_readme.md
@@ -0,0 +1,5 @@
+
+This item contains a complete PostgreSQL SQL database snapshot from https://fatcat.wiki, in binary 'pg_dump tar mode' format.
+
+With the exception of the 'abstracts' table (for which no aggregate license or copyright claims can be made; downstream users are responsible for their use), all metadata here is licensed CC-0 (public domain release) and may be used for any purpose. Downstream users are strongly encouraged to provide attribution and link here to the snapshot, as well as give credit to upstream sources (including Crossref, ORCID, DOAJ, the ISSN ROAD database, etc).
+
diff --git a/extra/sql_dumps/ia_sqldump_item_readme.md b/extra/sql_dumps/ia_sqldump_item_readme.md
new file mode 100644
index 00000000..d98d794c
--- /dev/null
+++ b/extra/sql_dumps/ia_sqldump_item_readme.md
@@ -0,0 +1,4 @@
+
+This item contains a complete PostgreSQL SQL database snapshot from https://fatcat.wiki, in binary 'pg_dump tar mode' format.
+
+With the exception of the 'abstracts' table (for which no aggregate license or copyright claims can be made; downstream users are responsible for their use), all metadata here is licensed CC-0 (public domain release) and may be used for any purpose. Downstream users are strongly encouraged to provide attribution and link here to the snapshot, as well as give credit to upstream sources (including Crossref, ORCID, DOAJ, the ISSN ROAD database, etc).