Resources for Docs WG members / Onboarding support
Workflows and rules
| Flow chart workflows | FOLIO chart Workflow |
|---|---|
| Rules for Weight: Sort entries for the website | Put it in the table at the beginning of google docs or in GitHub's md files |
Writing guidelines
| Style guide | https://developers.google.com/style |
|---|---|
| Markdown reference - what is Markdown? | https://www.markdownguide.org/getting-started/ |
| Markdown cheat sheet | https://www.markdownguide.org/cheat-sheet/ |
External Linking Language (Beginning with Poppy Release)
| Home page (https://docs.folio.org/docs/) | This documentation contains links to external sites. Please be advised that these sites are not maintained by the FOLIO Documentation Group and may be aligned with a different FOLIO release. |
|---|---|
| Individual pages where external links are present | This section of the documentation contains links to external sites. Please be advised that these sites are not maintained by the FOLIO Documentation Group and may be aligned with a different FOLIO release. |
Github
Docs github repository | https://github.com/folio-org/docs |
|---|---|
How to fork a repository | https://docs.github.com/en/get-started/quickstart/fork-a-repo |
| How to move a file to a new location | https://docs.github.com/en/repositories/working-with-files/managing-files/moving-a-file-to-a-new-location |
| Basic Github workflow for updating documentation on docs.folio.org | Basic Workflow in Github for Updating Existing Documentation |
| Training video | Short GitHub Overwiew by doc wg member |
Google Drive
| Link to Google Drive folder | |
|---|---|
| Basic Google Drive information for those maintaining docs on the drive | Basic workflow in Google Drive for creating and editing documentation |
Jira and Project Infrastructure
| Documentation Jira Project | |
|---|---|
| Release notes | Releases Home - see the table on the home page of this wiki space, or the space navigation tree on the left-hand side. |
| Using Jira to manage documentation work for docs.folio.org | Using Jira to manage work for docs.folio.org |
, multiple selections available,