Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

mkdocs: Fix ref not found warnings #955

Merged
merged 3 commits into from
May 5, 2024

Conversation

bact
Copy link
Contributor

@bact bact commented May 3, 2024

(A rework of #926 to fix unresolvable rebase/merge conflicts)

Fix ref/doc not found warnings during spec doc generation.

Currently, mkdocs serve and mkdocs build emit these warnings:

WARNING -  A reference to 'model/Software/Properties/isDirectory.md' is included in the 'nav' configuration, which is not
           found in the documentation files.
WARNING -  A reference to 'model/Dataset/Classes/Dataset.md' is included in the 'nav' configuration, which is not found
           in the documentation files.
WARNING -  A reference to 'model/Dataset/Properties/sensitivePersonalInformation.md' is included in the 'nav'
           configuration, which is not found in the documentation files.
WARNING -  A reference to 'model/AI/Properties/sensitivePersonalInformation.md' is included in the 'nav' configuration,
           which is not found in the documentation files.
WARNING -  Doc file 'conformance.md' contains a link 'diffs-from-previous-editions.md', but the target is not found among
           documentation files.
WARNING -  Doc file 'conformance.md' contains a link 'SPDX-Lite.md', but the target is not found among documentation
           files.

The first 4 warnings are responsible to the four erroneous None class/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:

The remaining 2 warnings are fixed by add directory name to the targets in conformance.md:

  • diffs-from-previous-editions.md and SPDX-Lite.md are in annexes/ directory
  • Note that conformance.md is not included yet in the 3.0 as the content is need to be updated for the version. So fixing these 2 warnings or not is not effecting what the public will see in the spec doc - yet, until we include the Conformance chapter to the spec.

A rework of spdx#926 to fix unresolvable merge conflicts

Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
bact added 2 commits May 3, 2024 17:08
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@bact
Copy link
Contributor Author

bact commented May 4, 2024

@goneall @kestewart this one is to replace the conflicted PR #926

Copy link
Member

@goneall goneall left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@goneall
Copy link
Member

goneall commented May 5, 2024

Since the previous PR was approved, I'll go ahead and merge this before another conflict

@goneall goneall merged commit 1e99ffc into spdx:development/v3.0.1 May 5, 2024
3 checks passed
@kestewart
Copy link
Contributor

Thanks Gary.

@bact bact deleted the fix-ref-not-found-warnings branch May 6, 2024 00:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants