docs: docgen proto with protoc-gen-doc
#557
Merged
Conversation
This file contains hidden or 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
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
andreas-hilti
approved these changes
Dec 31, 2024
Contributor
andreas-hilti
left a comment
andreas-hilti
left a comment
There was a problem hiding this comment.
Thanks, @jkowalleck! Looks good to me.
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
This was referenced Jan 11, 2025
jkowalleck
added a commit
that referenced
this pull request
Jan 11, 2025
theme for #557 --------- Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
n1ckl0sk0rtge
pushed a commit
to n1ckl0sk0rtge/specification
that referenced
this pull request
Feb 11, 2025
fixes CycloneDX#555 utilizes https://github.com/pseudomuto/protoc-gen-doc to generate the needed docs ready to upload to the homepage. > [!NOTE] > did not setup a proper template, yet. used the default one for now, so we can track template-related changes in future PRs > But the template has been foreseen, it is expected to go into the folder `docgen/proto/template`. > See template docs here: <https://github.com/pseudomuto/protoc-gen-doc/wiki/Custom-Templates> CI run: https://github.com/CycloneDX/specification/actions/runs/12536710058/job/34960006706 CI result: https://github.com/CycloneDX/specification/actions/runs/12536710058/artifacts/2369477602 structure: ```text docgen/proto/docs ├── 1.3 │ └── index.html ├── 1.4 │ └── index.html ├── 1.5 │ └── index.html └── 1.6 └── index.html ``` ---- might rework the resutling structure in regards to CycloneDX#568 --------- Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
n1ckl0sk0rtge
pushed a commit
to n1ckl0sk0rtge/specification
that referenced
this pull request
Feb 11, 2025
theme for CycloneDX#557 --------- Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
n1ckl0sk0rtge
pushed a commit
to n1ckl0sk0rtge/specification
that referenced
this pull request
Feb 11, 2025
fixes CycloneDX#555 utilizes https://github.com/pseudomuto/protoc-gen-doc to generate the needed docs ready to upload to the homepage. > [!NOTE] > did not setup a proper template, yet. used the default one for now, so we can track template-related changes in future PRs > But the template has been foreseen, it is expected to go into the folder `docgen/proto/template`. > See template docs here: <https://github.com/pseudomuto/protoc-gen-doc/wiki/Custom-Templates> CI run: https://github.com/CycloneDX/specification/actions/runs/12536710058/job/34960006706 CI result: https://github.com/CycloneDX/specification/actions/runs/12536710058/artifacts/2369477602 structure: ```text docgen/proto/docs ├── 1.3 │ └── index.html ├── 1.4 │ └── index.html ├── 1.5 │ └── index.html └── 1.6 └── index.html ``` ---- might rework the resutling structure in regards to CycloneDX#568 --------- Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
n1ckl0sk0rtge
pushed a commit
to n1ckl0sk0rtge/specification
that referenced
this pull request
Feb 11, 2025
theme for CycloneDX#557 --------- Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
fixes #555
utilizes https://github.com/pseudomuto/protoc-gen-doc
to generate the needed docs ready to upload to the homepage.
Note
did not setup a proper template, yet. used the default one for now, so we can track template-related changes in future PRs
But the template has been foreseen, it is expected to go into the folder
docgen/proto/template.See template docs here: https://github.com/pseudomuto/protoc-gen-doc/wiki/Custom-Templates
CI run: https://github.com/CycloneDX/specification/actions/runs/12536710058/job/34960006706
CI result: https://github.com/CycloneDX/specification/actions/runs/12536710058/artifacts/2369477602
structure:
might rework the resutling structure in regards to #568