The Opensource Transition Resource Guide is based off the modular docs project which is available on github.
https://redhat-documentation.github.io/modular-docs/
Templates for the various module types are available from the modular docs repo. All the module template files for writing new modular content can be found here:
https://github.com/redhat-documentation/modular-docs/tree/master/modular-docs-manual/files
Provide information for transgender and non binary folk to find information in their location as well as walk through how to do things like, changing your gender marker on official documentation or what the law regarding gender is in your location.
To help the documentation teams become more agile with their documentation. This agility will help us to better serve our readers with a more purposeful reading experience. A modular-based content model sets a foundation for innovation. Modular documentation provides a structure for writing and presenting user-story-based documentation. User-story-based documentation attempts to address the reader's needs more than focusing on feature-based documentation. User-story-based documentation also helps the documentation teams with the amount of documents that they have to maintain, by helping them to focus on what really matters.
Please submit an issue to this project.
This repository uses the following directory structure:
.
├── README.md (this file)
├── transition-resources/ (The guide)
├── README.md (the README file)
├── master.adoc (master layout of the book)
├── content/
├── topics/
└── *.adoc (AsciiDoc files)
└── modular-doc-manual.adoc
├── files/ (template files)
├── images (image files)
└── common-content
└── attributes.adoc (common attributes)
We welcome contributions from everyone who feels they have something of value that all of the community can benefit from. Follow these instructions to start contributing: CONTRIBUTING.
This work is licensed under the GNU General Public License.
When you make changes to these books, it is a good practice to do a local test build to verify the book builds successfully and renders as you expect before you submit the merge request back to upstream master.
You can build the book locally using AsciiDoctor.
To build and view the document locally, run the following scripts:
$ publish.sh
Alternatively, if you use VS Code, you can build the HTML from the "Run Menu". This will build the master docs list along with country specific docs. They are automatically placed under the website/static/guide folder. The website will link to the master pdf or the html version. Country specific pages will be available under a download link off the main page of the site.