search

perseids-publications / treebank-template

Template for publishing collections of treebanks.
https://perseids-publications.github.io/treebank-template/
MIT License
1 stars 9 forks source link

Add and update instructions #61

Closed zfletch closed 4 years ago

zfletch commented 4 years ago

Fixes https://github.com/perseids-publications/treebank-template/issues/54

This PR contains four commits addressing different parts of https://github.com/perseids-publications/treebank-template/issues/54:

  1. Add instructions for updating the .env file to the Getting Started page.
  2. Add a page explaining how to update the Treebank Template code using the update workflow.
  3. Update the DOI instructions to use Zenodo's GitHub integration. The new method doesn't require reserving a DOI before creating the publication and instead uses the DOI "for all versions" that Zenodo provides. The only downside is that the very first release won't contain its own DOI.
  4. (Breaking change) move instructions to the/instructions namespace, meaning /getting-started is now located at /instructions/getting-started and /doi is now located at /instructions/doi. This change means that we won't have to worry that new instructions will cause path conflicts. This commit also adds a header to /instructions/* for easier navigation.