Changes between Version 2 and Version 3 of Taskforces/CMDI/BestPracticesPublishing


Ignore:
Timestamp:
03/05/19 10:13:44 (5 years ago)
Author:
Twan Goosen
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Taskforces/CMDI/BestPracticesPublishing

    v2 v3  
    33Also see [[../BestPracticesEditing|CMDI Best Practices Guide editing procedure]].
    44
    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
     7On Overleaf, in the DRAFT version:
     81. 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 ==
    611
    712On GitHub, PUBLIC repository:
     
    1116    3. If there are changes that could be marged, make the pull request and merge into DRAFT
    1217
    13 == 2. On Overleaf, in the DRAFT version ==
     18== On Overleaf, in the DRAFT version ==
    1419    1. Synchronise with !GitHub (Menu -> !GitHub) and PULL incoming changes if there are any
    1520    2. Disable draft mode in the master tex file:
     
    2429    5. Label the version of the document (History -> Label this version) and include the version number in the label
    2530
    26 == 3. On !GitHub, DRAFT repository: ==
     31== On !GitHub, DRAFT repository: ==
    2732    1. Open a new pull request with
    2833        * base repository: clarin-eric/cmdi-best-practices; base: master
     
    3035    2. Inlcude 'Relase vX.Y.Z' in the pull request title
    3136
    32 == 4. On !GitHub, PUBLIC repository: ==
     37== On !GitHub, PUBLIC repository: ==
    3338    1. Go to pull requests and find the newly created release pull request
    3439    2. Merge the pull request
    3540    3. Make sure that the DRAFT version is fully ahead of the PUBLIC version (see above)
    3641
    37 == 5. On Overleaf, in the PUBLIC version: ==
     42== On Overleaf, in the PUBLIC version: ==
    3843    1. Synchronise with !GitHub (Menu -> !GitHub) and PULL incoming changes (there should be some!)
    3944    2. Compile and verify that the contents are correct and up-to-date
     
    4146    4. Download a PDF version of the document. Rename it to `cmdi_best_practices.pdf`
    4247
    43 == 6. On Overleaf, in the DRAFT version: ==
     48== On Overleaf, in the DRAFT version: ==
    4449    1. Synchronise with !GitHub (Menu -> !GitHub) and PULL incoming changes if there are any
    4550    2. Put the document in draft mode:
     
    5156    5. Verify that the DRAFT version is ahead of PUBLIC (the network graph is a useful tool for this)
    5257
    53 == 7. On !GitHub, PUBLIC repository: ==
     58== On !GitHub, PUBLIC repository: ==
    5459    1. Go to releases
    5560    2. Choose 'Draft a new release'
     
    5863    5. Attach the PDF file `cmdi_best_practices.pdf` to the release and publish
    5964
    60 == 8. Update the references on the CLARIN website ==
     65== Update the references on the CLARIN website ==
    6166    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)
    6267        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.