Skip to content

Commit

Permalink
Update information about stand-alone Python script
Browse files Browse the repository at this point in the history
  • Loading branch information
Steve Baskauf committed May 9, 2023
1 parent c8b45c9 commit f08ce18
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
4 changes: 4 additions & 0 deletions process/document_metadata_processing/tdwg_docs_workflow.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@
"source": [
"# Update TDWG documents metadata\n",
"\n",
"**NOTE: this script is no longer being maintained and should not be used. It is retained here for historical purposes**\n",
"\n",
"Instead, use the [stand-alone Python script](https://github.com/tdwg/rs.tdwg.org/blob/master/process/document_metadata_processing/tdwg_docs_metadata_update.py)\n",
"\n",
"Author: Steve Baskauf - 2022-05-27\n",
"\n",
"Version: 0.1\n",
Expand Down
2 changes: 1 addition & 1 deletion process/process-vocabulary.md
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ In order to use categories, edit the configuration section of the build script s

# 5 Managing documents metadata via Python script

After the vocabulary-related metadata are updated, metadata about human-readable documents MUST also be updated. Typically, this will be one or more list of terms documents that make it possible for humans to read the normative content related to the vocabulary terms. The metadata about each list of terms document involved MUST be updated one at a time, using [a Python script](https://github.com/tdwg/rs.tdwg.org/blob/master/process/document_metadata_processing/tdwg_docs_workflow.ipynb) that updates the document-related CSV files in the rs.tdwg.org repository. (Currenty on 2022-05-28 this script is in a Jupyter notebook, although after more testing and use, it will eventually be moved to a stand-alone script.)
After the vocabulary-related metadata are updated, metadata about human-readable documents MUST also be updated. Typically, this will be one or more list of terms documents that make it possible for humans to read the normative content related to the vocabulary terms. The metadata about each list of terms document involved MUST be updated one at a time, using [a Python script](https://github.com/tdwg/rs.tdwg.org/blob/master/process/document_metadata_processing/tdwg_docs_metadata_update.py) that updates the document-related CSV files in the rs.tdwg.org repository.

Before using the script, the rs.tdwg.org repository SHOULD be cloned to a local file system. The required configuration variables are in the file `general_configuration.yaml`, which MUST be in the same directory as the script. The following variables are included in the file:

Expand Down

0 comments on commit f08ce18

Please sign in to comment.