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.yml need to be updated to reflect current model files #902

Closed
rnjudge opened this issue Apr 9, 2024 · 3 comments
Closed

mkdocs.yml need to be updated to reflect current model files #902

rnjudge opened this issue Apr 9, 2024 · 3 comments
Milestone

Comments

@rnjudge
Copy link
Contributor

rnjudge commented Apr 9, 2024

As discussed this in the April 9 tech call, the list of model files in https://github.com/spdx/spdx-spec/blob/development/v3.0/mkdocs.yml#L21should be updated to reflect the current list of model classes/properties/vocabularies, etc files. Ideally, this would be auto-generated by the spec parser somehow as it does a directory walk of what's there.

Tagging @licquia and @zvr who have generously agreed to help with this :)

@zvr
Copy link
Member

zvr commented Apr 9, 2024

We should keep the order to the current one:

Core Software Security Licensing SimpleLicensing ExpandedLicensing Dataset AI Build Lite Extension

@zvr
Copy link
Member

zvr commented Apr 9, 2024

The generator will simply walk the directories. Typing a command line here (untested):

for i in Core Software Security Licensing SimpleLicensing ExpandedLicensing Dataset AI Build Lite Extension; do  printf "  -  ${i}:\n    - 'Description': model/$i/${i}.md\n"; for d in Classes Properties Vocabularies Individuals Datatypes ; do if [ -d $i/$d ] ; then printf "    - ${d}:\n" ; find $i/$d -type f -printf "      - model/%p\n" | sort ; fi ; done ; done

@goneall goneall added this to the 3.0 milestone Apr 14, 2024
@goneall
Copy link
Member

goneall commented Apr 14, 2024

Here's the current list of error and warnings from mkdocs:

INFO    -  The following pages exist in the docs directory, but are not included in the "nav" configuration:
  - ISO_foreword.md
  - conformance.md
  - annexes/SPDX-Lite.md
  - model/AI/Classes/EnergyConsumption.md
  - model/AI/Classes/EnergyConsumptionDescription.md
  - model/AI/Properties/energyQuantity.md
  - model/AI/Properties/energyUnit.md
  - model/AI/Properties/finetuningEnergyConsumption.md
  - model/AI/Properties/inferenceEnergyConsumption.md
  - model/AI/Properties/trainingEnergyConsumption.md
  - model/AI/Properties/useSensitivePersonalInformation.md
  - model/AI/Vocabularies/EnergyUnitType.md
  - model/Core/Individuals/NoAssertionElement.md
  - model/Core/Individuals/NoneElement.md
  - model/Dataset/Classes/DatasetPackage.md
  - model/Dataset/Properties/hasSensitivePersonalInformation.md
  - model/Extension/Classes/CdxPropertiesExtension.md
  - model/Extension/Classes/CdxPropertyEntry.md
  - model/Extension/Properties/cdxPropName.md
  - model/Extension/Properties/cdxPropValue.md
  - model/Extension/Properties/cdxProperty.md
  - model/Software/Classes/ContentIdentifier.md
  - model/Software/Properties/contentIdentifier.md
  - model/Software/Properties/contentIdentifierType.md
  - model/Software/Properties/contentIdentifierValue.md
  - model/Software/Properties/fileKind.md
  - model/Software/Vocabularies/ContentIdentifierType.md
  - model/Software/Vocabularies/FileKindType.md
WARNING -  A relative path to 'model/Software/Properties/gitoid.md' is included in the 'nav' configuration, which is not found in the documentation files.
WARNING -  A relative path to 'model/Software/Properties/isDirectory.md' is included in the 'nav' configuration, which is not found in the documentation files.
WARNING -  A relative path to 'model/Dataset/Classes/Dataset.md' is included in the 'nav' configuration, which is not found in the documentation files.
WARNING -  A relative path to 'model/Dataset/Properties/sensitivePersonalInformation.md' is included in the 'nav' configuration, which is not found in the documentation files.
WARNING -  A relative path to 'model/AI/Properties/sensitivePersonalInformation.md' is included in the 'nav' configuration, which is not found in the documentation files.
Could not load theme handler readthedocs: No module named 'mkdocs_pdf_export_plugin.themes.readthedocs'
WARNING -  Doc file 'conformance.md' contains a relative link 'diffs-from-previous-editions.md', but the target is not found among documentation files.
WARNING -  Doc file 'conformance.md' contains a relative link 'SPDX-Lite.md', but the target is not found among documentation files.
WARNING -  Doc file 'model/AI/Classes/AIPackage.md' contains a relative link '../../Core/Classes/PresenceType.md', but the target 'model/Core/Classes/PresenceType.md' is not found among documentation files.
WARNING -  Doc file 'model/AI/Classes/AIPackage.md' contains a relative link '../../Core/Classes/PresenceType.md', but the target 'model/Core/Classes/PresenceType.md' is not found among documentation files.
WARNING -  Doc file 'model/AI/Properties/autonomyType.md' contains a relative link '../../Core/Classes/PresenceType.md', but the target 'model/Core/Classes/PresenceType.md' is not found among documentation files.
WARNING -  Doc file 'model/AI/Properties/useSensitivePersonalInformation.md' contains a relative link '../../Core/Classes/PresenceType.md', but the target 'model/Core/Classes/PresenceType.md' is not found among documentation files.
WARNING -  Doc file 'model/Build/Classes/Build.md' contains a relative link '../../Core/Classes/DateTime.md', but the target 'model/Core/Classes/DateTime.md' is not found among documentation files.
WARNING -  Doc file 'model/Build/Classes/Build.md' contains a relative link '../../Core/Classes/DateTime.md', but the target 'model/Core/Classes/DateTime.md' is not found among documentation files.
WARNING -  Doc file 'model/Build/Properties/buildEndTime.md' contains a relative link '../../Core/Classes/DateTime.md', but the target 'model/Core/Classes/DateTime.md' is not found among documentation files.
WARNING -  Doc file 'model/Build/Properties/buildStartTime.md' contains a relative link '../../Core/Classes/DateTime.md', but the target 'model/Core/Classes/DateTime.md' is not found among documentation files.
WARNING -  Doc file 'model/Dataset/Classes/DatasetPackage.md' contains a relative link '../../Core/Classes/PresenceType.md', but the target 'model/Core/Classes/PresenceType.md' is not found among documentation files.
WARNING -  Doc file 'model/Dataset/Properties/hasSensitivePersonalInformation.md' contains a relative link '../../Core/Classes/PresenceType.md', but the target 'model/Core/Classes/PresenceType.md' is not found among documentation files.
WARNING -  Doc file 'model/Security/Classes/EpssVulnAssessmentRelationship.md' contains a relative link '../../Core/Classes/DateTime.md', but the target 'model/Core/Classes/DateTime.md' is not found among documentation files.
WARNING -  Doc file 'model/Security/Classes/VexAffectedVulnAssessmentRelationship.md' contains a relative link '../../Core/Classes/DateTime.md', but the target 'model/Core/Classes/DateTime.md' is not found among documentation files.
WARNING -  Doc file 'model/Security/Classes/VexNotAffectedVulnAssessmentRelationship.md' contains a relative link '../../Core/Classes/DateTime.md', but the target 'model/Core/Classes/DateTime.md' is not found among documentation files.
WARNING -  Doc file 'model/Security/Classes/VulnAssessmentRelationship.md' contains a relative link '../../Core/Classes/DateTime.md', but the target 'model/Core/Classes/DateTime.md' is not found among documentation files.
WARNING -  Doc file 'model/Security/Classes/VulnAssessmentRelationship.md' contains a relative link '../../Core/Classes/DateTime.md', but the target 'model/Core/Classes/DateTime.md' is not found among documentation files.
WARNING -  Doc file 'model/Security/Classes/VulnAssessmentRelationship.md' contains a relative link '../../Core/Classes/DateTime.md', but the target 'model/Core/Classes/DateTime.md' is not found among documentation files.
WARNING -  Doc file 'model/Security/Classes/Vulnerability.md' contains a relative link '../../Core/Classes/DateTime.md', but the target 'model/Core/Classes/DateTime.md' is not found among documentation files.
WARNING -  Doc file 'model/Security/Classes/Vulnerability.md' contains a relative link '../../Core/Classes/DateTime.md', but the target 'model/Core/Classes/DateTime.md' is not found among documentation files.
WARNING -  Doc file 'model/Security/Classes/Vulnerability.md' contains a relative link '../../Core/Classes/DateTime.md', but the target 'model/Core/Classes/DateTime.md' is not found among documentation files.
WARNING -  Doc file 'model/Security/Properties/actionStatementTime.md' contains a relative link '../../Core/Classes/DateTime.md', but the target 'model/Core/Classes/DateTime.md' is not found among documentation files.
WARNING -  Doc file 'model/Security/Properties/impactStatementTime.md' contains a relative link '../../Core/Classes/DateTime.md', but the target 'model/Core/Classes/DateTime.md' is not found among documentation files.
WARNING -  Doc file 'model/Security/Properties/modifiedTime.md' contains a relative link '../../Core/Classes/DateTime.md', but the target 'model/Core/Classes/DateTime.md' is not found among documentation files.
WARNING -  Doc file 'model/Security/Properties/publishedTime.md' contains a relative link '../../Core/Classes/DateTime.md', but the target 'model/Core/Classes/DateTime.md' is not found among documentation files.
WARNING -  Doc file 'model/Security/Properties/withdrawnTime.md' contains a relative link '../../Core/Classes/DateTime.md', but the target 'model/Core/Classes/DateTime.md' is not found among documentation files.
WARNING -  Doc file 'model/SimpleLicensing/Classes/LicenseExpression.md' contains a relative link '../../Core/Classes/SemVer.md', but the target 'model/Core/Classes/SemVer.md' is not found among documentation files.
WARNING -  Doc file 'model/SimpleLicensing/Properties/licenseListVersion.md' contains a relative link '../../Core/Classes/SemVer.md', but the target 'model/Core/Classes/SemVer.md' is not found among documentation files.
WARNING -  Doc file 'model/Software/Classes/File.md' contains a relative link '../../Core/Classes/MediaType.md', but the target 'model/Core/Classes/MediaType.md' is not found among documentation files.
WARNING -  Doc file 'model/Software/Properties/contentType.md' contains a relative link '../../Core/Classes/MediaType.md', but the target 'model/Core/Classes/MediaType.md' is not found among documentation files.
Error converting ISO_foreword.md to PDF: 'ISO_foreword/' is not in list
Error converting conformance.md to PDF: 'conformance/' is not in list
Error converting annexes/SPDX-Lite.md to PDF: 'annexes/SPDX-Lite/' is not in list
Error converting model/AI/Classes/EnergyConsumption.md to PDF: 'model/AI/Classes/EnergyConsumption/' is not in list
Error converting model/AI/Classes/EnergyConsumptionDescription.md to PDF: 'model/AI/Classes/EnergyConsumptionDescription/' is not in list
Error converting model/AI/Properties/energyQuantity.md to PDF: 'model/AI/Properties/energyQuantity/' is not in list
Error converting model/AI/Properties/energyUnit.md to PDF: 'model/AI/Properties/energyUnit/' is not in list
Error converting model/AI/Properties/finetuningEnergyConsumption.md to PDF: 'model/AI/Properties/finetuningEnergyConsumption/' is not in list
Error converting model/AI/Properties/inferenceEnergyConsumption.md to PDF: 'model/AI/Properties/inferenceEnergyConsumption/' is not in list
Error converting model/AI/Properties/trainingEnergyConsumption.md to PDF: 'model/AI/Properties/trainingEnergyConsumption/' is not in list
Error converting model/AI/Properties/useSensitivePersonalInformation.md to PDF: 'model/AI/Properties/useSensitivePersonalInformation/' is not in list
Error converting model/AI/Vocabularies/EnergyUnitType.md to PDF: 'model/AI/Vocabularies/EnergyUnitType/' is not in list
Error converting model/Core/Individuals/NoAssertionElement.md to PDF: 'model/Core/Individuals/NoAssertionElement/' is not in list
Error converting model/Core/Individuals/NoneElement.md to PDF: 'model/Core/Individuals/NoneElement/' is not in list
Error converting model/Dataset/Classes/DatasetPackage.md to PDF: 'model/Dataset/Classes/DatasetPackage/' is not in list
Error converting model/Dataset/Properties/hasSensitivePersonalInformation.md to PDF: 'model/Dataset/Properties/hasSensitivePersonalInformation/' is not in list
Error converting model/Extension/Classes/CdxPropertiesExtension.md to PDF: 'model/Extension/Classes/CdxPropertiesExtension/' is not in list
Error converting model/Extension/Classes/CdxPropertyEntry.md to PDF: 'model/Extension/Classes/CdxPropertyEntry/' is not in list
Error converting model/Extension/Properties/cdxPropName.md to PDF: 'model/Extension/Properties/cdxPropName/' is not in list
Error converting model/Extension/Properties/cdxPropValue.md to PDF: 'model/Extension/Properties/cdxPropValue/' is not in list
Error converting model/Extension/Properties/cdxProperty.md to PDF: 'model/Extension/Properties/cdxProperty/' is not in list
Error converting model/Software/Classes/ContentIdentifier.md to PDF: 'model/Software/Classes/ContentIdentifier/' is not in list
Error converting model/Software/Properties/contentIdentifier.md to PDF: 'model/Software/Properties/contentIdentifier/' is not in list
Error converting model/Software/Properties/contentIdentifierType.md to PDF: 'model/Software/Properties/contentIdentifierType/' is not in list
Error converting model/Software/Properties/contentIdentifierValue.md to PDF: 'model/Software/Properties/contentIdentifierValue/' is not in list
Error converting model/Software/Properties/fileKind.md to PDF: 'model/Software/Properties/fileKind/' is not in list
Error converting model/Software/Vocabularies/ContentIdentifierType.md to PDF: 'model/Software/Vocabularies/ContentIdentifierType/' is not in list
Error converting model/Software/Vocabularies/FileKindType.md to PDF: 'model/Software/Vocabularies/FileKindType/' is not in list

rnjudge added a commit to rnjudge/spdx-spec that referenced this issue Apr 14, 2024
Update mkdocs.yml and fix some of the ordering/formatting in the
annexes. The updates to mkdocs.yml reflect the most current state of the
model.

Addresses spdx#902

Signed-off-by: Rose Judge <rose.judge@broadcom.com>
goneall pushed a commit that referenced this issue Apr 14, 2024
Update mkdocs.yml and fix some of the ordering/formatting in the
annexes. The updates to mkdocs.yml reflect the most current state of the
model.

Addresses #902

Signed-off-by: Rose Judge <rose.judge@broadcom.com>
@rnjudge rnjudge closed this as completed Apr 14, 2024
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

No branches or pull requests

3 participants