{"id":22859855,"url":"https://github.com/redhat-documentation/modular-docs","last_synced_at":"2026-01-11T01:30:02.012Z","repository":{"id":22942394,"uuid":"89649360","full_name":"redhat-documentation/modular-docs","owner":"redhat-documentation","description":"Modular Documentation Project provides guidelines and examples for writing technical documentation using a modular framework.","archived":false,"fork":false,"pushed_at":"2024-02-16T14:33:34.000Z","size":15848,"stargazers_count":84,"open_issues_count":18,"forks_count":69,"subscribers_count":43,"default_branch":"main","last_synced_at":"2025-02-06T12:48:08.600Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc-by-sa-4.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/redhat-documentation.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-04-27T23:42:44.000Z","updated_at":"2025-01-12T16:05:47.000Z","dependencies_parsed_at":"2023-12-20T15:04:33.909Z","dependency_job_id":"c0a39a3a-eaa4-4373-8317-7cece16f1cc8","html_url":"https://github.com/redhat-documentation/modular-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redhat-documentation%2Fmodular-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redhat-documentation%2Fmodular-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redhat-documentation%2Fmodular-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redhat-documentation%2Fmodular-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/redhat-documentation","download_url":"https://codeload.github.com/redhat-documentation/modular-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246436696,"owners_count":20777071,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-13T09:08:13.544Z","updated_at":"2026-01-11T01:30:01.857Z","avatar_url":"https://github.com/redhat-documentation.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# The Modular Documentation Project Source Repository\n\n## Modular Documentation Reference Guide ![Build Status](https://github.com/redhat-documentation/modular-docs/actions/workflows/deploy-site.yml/badge.svg)\n\nThe Modular Documentation Reference Guide contains the essential information to start writing documentation in a modular way.\nYou can view the latest build of the guide here:\n\nhttps://redhat-documentation.github.io/modular-docs/\n\n## Modular Documentation Template Files\n\nAnother deliverable for this project is the module templates for the various module types.\nAll the module template files for writing new modular content can be found here:\n\nhttps://github.com/redhat-documentation/modular-docs/tree/master/modular-docs-manual/files\n\n## What is the Purpose of the Modular Documentation Project?\n\nTo provide documentation teams with a set of resources to assist them as they write user-driven content or convert their current documentation framework to a modular-based documentation framework.\n\n## Why Are We Doing This?\n\nTo 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.\n\n## Any Suggestions or Questions?\n\nPlease submit an [issue](https://github.com/redhat-documentation/modular-docs/issues) to this project.\n\n## Repository Structure\n\nThis repository uses the following directory structure:\n\n```\n.\n├── .travis.yml (YAML configuration file for Travis CI)\n├── CONTRIBUTING.md (How do I contribute to this project?)\n├── README.md (this file)\n├── modular-docs-manual/ (Another book)\n    ├── README.md (the README file)\n    ├── master.adoc (master layout of the book)\n    ├── content/\n        ├── topics/\n            └── *.adoc (AsciiDoc files)\n        └── modular-doc-manual.adoc\n    ├── files/ (template files)\n    ├── images (image files)\n    └── common-content\n        └── attributes.adoc (common attributes)\n```\n\n## Contributing\n\nWe 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](CONTRIBUTING.md).\n\n## License\n\nThis work is licensed under the [Creative Commons Attribution-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/).\n\n## Building the Books Locally\n\nWhen 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.\n\n### Configuring the Build Environment\n\nYou can build the book locally using [AsciiDoctor](http://asciidoctor.org/docs/#get-started-with-asciidoctor).\n\n### Building the Modular Documentation Reference Guide\n\nTo build and view the document locally, run:\n\n```\n$ asciidoctor modular-docs-manual/master.adoc\n$ \u003cwww-browser-of-choice\u003e modular-docs-manual/master.html\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fredhat-documentation%2Fmodular-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fredhat-documentation%2Fmodular-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fredhat-documentation%2Fmodular-docs/lists"}