Changes between Version 2 and Version 3 of Taskforces/CMDI/BestPracticesPublishing
- Timestamp:
- 03/05/19 10:13:44 (5 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
Taskforces/CMDI/BestPracticesPublishing
v2 v3 3 3 Also see [[../BestPracticesEditing|CMDI Best Practices Guide editing procedure]]. 4 4 5 == 1. Make sure that the DRAFT version is fully ahead of the PUBLIC version == 5 == Synchronise uncomitted changes in the DRAFT document with !GitHub repository == 6 7 On Overleaf, in the DRAFT version: 8 1. Synchronise the Overleaf document with !GitHub: Menu -> !GitHub -> Push overleaf changes to !GitHub 9 10 == Make sure that the DRAFT version is fully ahead of the PUBLIC version == 6 11 7 12 On GitHub, PUBLIC repository: … … 11 16 3. If there are changes that could be marged, make the pull request and merge into DRAFT 12 17 13 == 2.On Overleaf, in the DRAFT version ==18 == On Overleaf, in the DRAFT version == 14 19 1. Synchronise with !GitHub (Menu -> !GitHub) and PULL incoming changes if there are any 15 20 2. Disable draft mode in the master tex file: … … 24 29 5. Label the version of the document (History -> Label this version) and include the version number in the label 25 30 26 == 3.On !GitHub, DRAFT repository: ==31 == On !GitHub, DRAFT repository: == 27 32 1. Open a new pull request with 28 33 * base repository: clarin-eric/cmdi-best-practices; base: master … … 30 35 2. Inlcude 'Relase vX.Y.Z' in the pull request title 31 36 32 == 4.On !GitHub, PUBLIC repository: ==37 == On !GitHub, PUBLIC repository: == 33 38 1. Go to pull requests and find the newly created release pull request 34 39 2. Merge the pull request 35 40 3. Make sure that the DRAFT version is fully ahead of the PUBLIC version (see above) 36 41 37 == 5.On Overleaf, in the PUBLIC version: ==42 == On Overleaf, in the PUBLIC version: == 38 43 1. Synchronise with !GitHub (Menu -> !GitHub) and PULL incoming changes (there should be some!) 39 44 2. Compile and verify that the contents are correct and up-to-date … … 41 46 4. Download a PDF version of the document. Rename it to `cmdi_best_practices.pdf` 42 47 43 == 6.On Overleaf, in the DRAFT version: ==48 == On Overleaf, in the DRAFT version: == 44 49 1. Synchronise with !GitHub (Menu -> !GitHub) and PULL incoming changes if there are any 45 50 2. Put the document in draft mode: … … 51 56 5. Verify that the DRAFT version is ahead of PUBLIC (the network graph is a useful tool for this) 52 57 53 == 7.On !GitHub, PUBLIC repository: ==58 == On !GitHub, PUBLIC repository: == 54 59 1. Go to releases 55 60 2. Choose 'Draft a new release' … … 58 63 5. Attach the PDF file `cmdi_best_practices.pdf` to the release and publish 59 64 60 == 8.Update the references on the CLARIN website ==65 == Update the references on the CLARIN website == 61 66 1. Update the links at https://www.clarin.eu/content/component-metadata and https://www.clarin.eu/content/cmdi-best-practice-guide (you need editing rights for this) 62 67 1. These must point to `https://github.com/clarin-eric/cmdi-best-practices/releases/download/x.y.z/cmdi_best_practices.pdf` where x.y.z is the version/tag of the new release.