The guideline name

Technical Guideline Series

Authors

Affiliations

AAA BBB

Whatever Institute

CCC DDD

Another Great Institute

Published

October 25, 2023

Doi

10.5281/zenodo.10037104

Abstract

The short abstract goes here and can go over multiple lines. …

%Please fill in the headers accordingly.% %INCREASE THE VERSION BEFORE A NEW RELEASE.% % All parts which need to be changed are marked with a % sign.%

Reviewed by:

%Aidin Niamir%
%Yanina V. Sica% - IPBES Technical Support Unit for Knowledge and Data
…

For any inquires please contact aidin.niamir@senckenberg.de

Workflow for TG Development (Here goes the TG)

Version: 0.0.1

Update all metadata and the version number in the README.md YAML headers of this file
Add abstract to both documents
Link the github repo to Zenodo so that each release is automatically added to Zenodo
Write the TG in this document

Workflow for TG Publication

Publication is done by creaating a new release, which is automatically pushed to zenodo as the repository is linked to Zenodo. There are a few manual steps which need to be done:

Update the version number in the `YAML headers of this file
render this document to HTML (at the moment, the only supported format - but we can think about offering pdf versions for the offline reading)
Check the renderd html document and make sure that all links are working and that the document is rendered correctly
Do a final check of the README.md to make sure that it is still up to date
Make sure that the version in the document and the tag for the release corresponds (i.e. tag should be vX.Y.Z)
Create a new release on github and upload the rendered html document as a release asset

Workflow for review

Export the TG as a docx file
upload the docx file to google drive (convert it if you want to to google doc format - it makes it faster to wotk with the document but it not necessary)
get the link to the TG on google drive (The share sould be Comment only!) and add it to this TG file To review, click here
export the TG to pdf, which now contains the link to the google doc
send the pdf to the reviewers with the information that for reviewing, they should open the document on google docs using the link in the document (and in the email)
at ther end, transfer the requested changes from the google doc to the TG and update the html on github

Reuse

https://creativecommons.org/licenses/by/4.0/

Citation

BibTeX citation:

@report{bbb2023,
  author = {BBB, AAA and DDD, CCC},
  title = {The Guideline Name},
  pages = {undefined},
  date = {2023-10-25},
  doi = {10.5281/zenodo.10037104},
  langid = {en},
  abstract = {The short abstract goes here and can go over multiple
    lines. ...}
}

For attribution, please cite this work as:

BBB, AAA, and CCC DDD. 2023. “The Guideline Name.” IPBES Technical Guidelines Series. https://doi.org/10.5281/zenodo.10037104.