Validate documentation #938
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
JPEWdev
force-pushed
the
development/v3.0.1
branch
from
f6e67ef to
c96c618
Compare
goneall
approved these changes
Apr 23, 2024
JPEWdev
force-pushed
the
development/v3.0.1
branch
2 times, most recently
from
f8cb472 to
3615a65
Compare
maxhbr
reviewed
May 9, 2024
docs/annexes/cross-reference.md
Outdated
| Markdown file, use the following command: | ||
|
|
||
| ```shell | ||
| cat getting-started.md | awk 'BEGIN{flag=0} /^```json/, $0=="```" { if (/^---$/){flag++} else if ($0 !~ /^```.*/ ) print $0 > "doc-" flag ".spdx.json"}' |
There was a problem hiding this comment.
Suggested change
| cat getting-started.md | awk 'BEGIN{flag=0} /^```json/, $0=="```" { if (/^---$/){flag++} else if ($0 !~ /^```.*/ ) print $0 > "doc-" flag ".spdx.json"}' | |
| cat cross-reference.md | awk 'BEGIN{flag=0} /^```json/, $0=="```" { if (/^---$/){flag++} else if ($0 !~ /^```.*/ ) print $0 > "doc-" flag ".spdx.json"}' |
|
I just added the functionality to load multiple documents to my tool https://github.com/maxhbr/spdx3ToGraph and this generates the following for the cross-reference.md example:
|
Very cool! |
JPEWdev
force-pushed
the
development/v3.0.1
branch
2 times, most recently
from
bceef54 to
c5354db
Compare
This made me realize I forgot the |
|
update:
|
maxhbr
reviewed
May 9, 2024
Signed-off-by: Joshua Watt <[email protected]>
Updates the security information Annex to conform to the SPDX 3.0 schema and model. In addition, the CI workflow is updated to use a standalone script to do the validation (making it easier to validate locally). When validation documentation files, the script will now detect if the documentation is a complete document or just fragements of a document. In the latter case, a wrapper is made around the JSON from the documentation to make it a valid document for validation (e.g. "@context", "@graph", and a CreationInfo). Signed-off-by: Joshua Watt <[email protected]>
Adds a markdown document with examples that explains how to refer to elements across documents Signed-off-by: Joshua Watt <[email protected]>
JPEWdev
force-pushed
the
development/v3.0.1
branch
from
b7d4466 to
c4a117c
Compare
kestewart
approved these changes
May 23, 2024
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.
Validates security documentation