forked from speced/respec
-
Notifications
You must be signed in to change notification settings - Fork 0
Reviewversies publiceren
Elisabeth de Vries edited this page Jul 6, 2023
·
8 revisions
Deze pagina beschrijft hoe je handmatig een (interne of externe) reviewversie publiceert.
Je hebt hierbij Visual Studio Code nodig.
- Open het document en publiceer een locale versie van het document vanaf de index ("Go live")
- In config: Verander de specStatus: "IR", update config op github
- Voeg in config de volgende zaken toe (tijdelijk)
- Zorg voor toevoegen van reviewmogelijkheid: hypothesisComments: "true",
- Voeg toe reviewDateEnd: "yyyy-mm-dd",
- Sla de locale versie van het document op als index.html via de "Respec knop" rechts bovenaan de pagina (dus niet via je browser) met "bewaar snapshot" en "html", en druk het (wel via je browser) af als pdf
- Plaats de HTML-pagina en de bijbehorende map met bestanden met een logische naam en locatie op github (in de map van waaruit het brondocument wordt gepubliceerd*), een logische naam is bijvoorbeeld de status en datum "naamdocument@IR-20230101"
- Gooi de tijdelijke wijzigingen in de config weg, vooral hypothesis, anders kunnen mensen opmerkingen gaan plaatsen in je brondocument
- Zoek uit wat de link is naar je reviewdocument (crow.github.io/naamdocument/naamdocument@IR-20230101) en stuur al je connecties de link om te reviewen.
* Als er gepubliceerd wordt vanuit de gh-pages
branch, moet je die documenten in die branch neerzetten.