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

Lowercase filenames for cleaner URLs #1052

Merged
merged 5 commits into from
Aug 12, 2024

Conversation

bact
Copy link
Collaborator

@bact bact commented Aug 11, 2024

Note - spdx/spdx-3-model#840 has to be applied first, before this PR.

For cleaner URLs, propose to rename these files:

  • SPDX-Lite.md to spdx-lite.md
  • SPDX-license-expressions.md to spdx-license-expressions.md

Other files are already in all-lowercase, including ones with a word which originally an all-uppercase initialism:

  • changes-from-previous-iso.md (ISO)
  • pkg-url-specification.md (URL)
  • rdf-model.md (RDF)

The all-lowercase spdx will also match the other spdx instances in the full URL of: https://spdx.github.io/spdx-spec/...

I'm suggesting we have this before the publication of v3.0.1 website, so the URLs stay the same. (This is not affect the PDF generation)

Will fix #1051 (follow up of #1044 (comment) )

Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@bact bact changed the title Lowercase filenames Lowercase filenames for cleaner URLs Aug 11, 2024
@bact bact added this to the 3.0.1 milestone Aug 11, 2024
@bact bact requested review from goneall and kestewart August 11, 2024 22:08
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@bact
Copy link
Collaborator Author

bact commented Aug 11, 2024

These two warnings are to be fixed by spdx/spdx-3-model#840 in spdx-3-model

WARNING - Doc file 'model/ExpandedLicensing/ExpandedLicensing.md' contains a link '../../annexes/SPDX-license-expressions.md', but the target 'annexes/SPDX-license-expressions.md' is not found among documentation files.

WARNING - Doc file 'model/ExpandedLicensing/Classes/ConjunctiveLicenseSet.md' contains a link '../../../annexes/SPDX-license-expressions.md', but the target 'annexes/SPDX-license-expressions.md' is not found among documentation files.

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

Copy link

@bobmartin3000 bobmartin3000 left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@kestewart kestewart left a comment

Choose a reason for hiding this comment

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

Looks good as soon as it's passing the checks.

@bact
Copy link
Collaborator Author

bact commented Aug 11, 2024

@kestewart Warnings fixed in spdx/spdx-3-model#840 -- have to merge that first in spdx-3-model, before this PR can pass the validation.

Copy link
Contributor

@kestewart kestewart left a comment

Choose a reason for hiding this comment

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

Have merged spdx/spdx-3-model#840, so trying to get this to sort.

@kestewart
Copy link
Contributor

@goneall - can you see if you can get the Validate build working.

@bact
Copy link
Collaborator Author

bact commented Aug 12, 2024

@kestewart it's validated now

@goneall
Copy link
Member

goneall commented Aug 12, 2024

spdx/spdx-3-model#840 was merged, so this can / must be merged for validation to pass

@goneall goneall merged commit 22677c8 into spdx:development/v3.0.1 Aug 12, 2024
3 checks passed
@bact bact deleted the lowercase-annex-filenames branch August 12, 2024 08:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rename filenames to all lowercase for consistency and cleaner URLs
4 participants