This repository has been archived by the owner on May 6, 2022. It is now read-only.
Generate docs from specfiles #61
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3d23e6d to
c92ed60
Compare
|
I like the idea, nice! yes, a README file per package looks like a good a nice easy too read approach. |
davidcassany
approved these changes
Dec 2, 2021
This PR introduce a script which generates layout/structure to be parsed from our docs to be displayed in the website. It parses the cos-toolkit repository packages and scans for `README.md` files present in the package path (where `build.yaml` and `definition.yaml` reside). If it's a collection, it still reads for README files, but allows also to generate per-package documentation by checking the presence of `README-cat-name.md` in the package path, if present it will create a new grouped page and put the packages of the collection under it. In order to preserve readability on cos-toolkit side, the page header of a collection cannot be generated cleanly, so a `README-head.md` file is required with the specific docsy fields, e.g: ```yaml --- title: "Collection name" linkTitle: "Collection title" date: 2021-12-02 description: > Collection description --- ``` Needs: rancher/elemental-toolkit#907 Part of: rancher/elemental-toolkit#757 Add makefile target and hook into CI Signed-off-by: Ettore Di Giacinto <edigiacinto@suse.com>
Signed-off-by: Ettore Di Giacinto <edigiacinto@suse.com>
|
I'll follow up with PRs updating the docs, merging this |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Needs: rancher/elemental-toolkit#907
Part of: rancher/elemental-toolkit#757
This PR introduce a script which generates layout/structure to be parsed from our docs to be displayed in the website. It parses the cos-toolkit repository packages and scans for
README.mdfiles present in the package path (wherebuild.yamlanddefinition.yamlreside).If it's a collection, it still reads for README files, but allows also to generate per-package documentation by checking the presence of
README-cat-name.mdin the package path, if present it will create a new grouped page and put the packages of the collection under it.In order to preserve readability on cos-toolkit side, the page header of a collection cannot be generated cleanly, so a
README-head.mdfile is required with the specific docsy fields, e.g:WIP as I'm currently moving other docs over the repo, so we have more contextual docs