mkdocs: Fix file not found warnings #926
Closed
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
goneall
approved these changes
Apr 22, 2024
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
We switched over to using the GitHub release notes on version 2.3 and later. This adds references to the GitHub release notes in the CHANGELOG.md Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
The check assumes that JSON example snippets are all parts of a single JSON document that needs validating, but not all files are written that way. To avoid errors that have nothing to do with the correctness of the examples, we should only check files which meet the check's assumptions. Fixes spdx#912. Signed-off-by: Jeff Licquia <jeff@licquia.org> Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
bact
force-pushed
the
fix-file-not-found-warnings
branch
from
851b96b
to
a57c094
Compare
kestewart
approved these changes
May 3, 2024
|
@bact - can you resolve the merge conflicts - thanks |
I cannot see any changes from the last commit but GitHub still say that there're conflicts. So trying to change minor things. (note the newline break between lines 7 and 8) Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
bact
added a commit
to bact/spdx-spec
that referenced
this pull request
May 3, 2024
A rework of spdx#926 to fix unresolvable merge conflicts Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
|
@goneall @kestewart I have tried to resolve the merge conflicts but I cannot see any changes from the development/v3.0.1 branch that will cause the conflict. The bact:fix-file-not-found-warnings branch is basically ahead of the development/v3.0.1 branch without any behind commits. I opened a new PR #955 and copied the changes from this PR over. If you can re-review in that PR. I can close this PR if agreed. Sorry for inconvenience. |
goneall
pushed a commit
that referenced
this pull request
May 5, 2024
A rework of #926 to fix unresolvable merge conflicts Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
|
Close - merged in #955 |
bact
added a commit
to bact/spdx-spec
that referenced
this pull request
Jun 10, 2024
A rework of spdx#926 to fix unresolvable merge conflicts Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
vargenau
pushed a commit
to vargenau/spdx-spec
that referenced
this pull request
Jul 18, 2024
A rework of spdx#926 to fix unresolvable merge conflicts Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com> Signed-off-by: Marc-Etienne Vargenau <marc-etienne.vargenau@nokia.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.
Fix file not found issues in spec doc generation.
Currently,
mkdocs serveandmkdocs buildemit these warnings:The first 4 warnings are responsible to the four erroneous
Noneclass/properties displaying in the left pane of https://spdx.github.io/spdx-spec/v3.0/ . They are all old property names. New property names are already included in the nav. Fixed by removing all 4 outdated references:model/Software/Properties/isDirectory.mdis nowfileKindmodel/Dataset/Classes/Dataset.mdis nowDatasetPackagemodel/Dataset/Properties/sensitivePersonalInformation.mdis nowhasSensitivePersonalInformationmodel/AI/Properties/sensitivePersonalInformation.mdis nowuseSensitivePersonalInformationThe remaining 2 warnings are fixed by add directory name to the targets:
diffs-from-previous-editions.mdandSPDX-Lite.mdare inannexes/directory