-
Notifications
You must be signed in to change notification settings - Fork 9
How we work
The Technical Documentation, State of the Ecosystem is organized with bookdown with each chapter describing a different dataset available in ecodata. The individual Rmarkdown files are stored in the chapters folder and listed in the _bookdown.yml.
For the most part, the book is maintained by one individual but can be edited by anyone. Collaborators can either clone the repo and make edits locally or make changes directly on GitHub. This just requires the collaborator to know basic Rmarkdown.
This repository uses GitHub actions to build and deploy the book on a commit and push so it is not required to build the book locally as it is time-consuming and redundant. An HTML version is built and deployed on each push and once a year a PDF version is built locally by the maintainer so a copy can be included in the NOAA Institutional Repository along with the State of the Ecosystem Reports.
In the past, we have had issues with line endings from collaborators using different machines (issue #66). However, those issues seem to resolve themselves once the collaborator pushed and pulled the repo again. If these issues occur, please pull and push with a simple line edit to normalize the repo.