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

Preparing for submissions #1099

Merged
merged 3 commits into from
Sep 3, 2024
Merged

Preparing for submissions #1099

merged 3 commits into from
Sep 3, 2024

Conversation

zvr
Copy link
Member

@zvr zvr commented Aug 30, 2024

The files in this repo are used to create three different editions of the Specification:

  1. the one presented in HTML
  2. a PDF, to be submitted to OMG
  3. a PDF, to be submitted to ISO

Unfortunately, the content is not exactly the same in all of them.

This PR:

  • Moves files around to facilitate preparation of the 3 editions
  • Updates mkdocs config to use new paths (for the first one)

Note:
There will be a fourth edition, a PDF version for SPDX website, but this content will very closely match the HTML one (1, above) and in any case is not ready right now.

@zvr zvr requested review from bact, goneall and kestewart August 30, 2024 13:37
@zvr zvr added this to the 3.0.1 milestone Aug 30, 2024
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.

Changes look reasonable to me with the caveat that I don't have much expertise in the mkdocs tooling.

@bact
Copy link
Collaborator

bact commented Sep 1, 2024

There are currently two warnings during PR validation:

WARNING - Doc file 'front/index.md' contains a link './licenses/Community-Spec-1.0.md', but the target 'front/licenses/Community-Spec-1.0.md' is not found among documentation files.

WARNING - Doc file 'front/index.md' contains a link './licenses/CC-BY-3.0.md', but the target 'front/licenses/CC-BY-3.0.md' is not found among documentation files.

Copy link
Collaborator

@bact bact left a comment

Choose a reason for hiding this comment

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

Links in Lines 9 and 13 may need to update:

  • ./licenses/Community-Spec-1.0.md -> ../licenses/Community-Spec-1.0.md

  • ./licenses/CC-BY-3.0.md -> ../licenses/CC-BY-3.0.md

@bact bact added publishing ci Dev workflow and repo management labels Sep 3, 2024
@zvr
Copy link
Member Author

zvr commented Sep 3, 2024

It's unfortunate that mkdocs and LaTeX treat relative filenames differently...
On the other hand, we're fortunate that this is only on the index file, which is different in LaTeX editions anyway, so no harm done.

[editing this comment:]
ah, it's not file inclusion, it's link reference. Ignore the previous.

Signed-off-by: Alexios Zavras <[email protected]>
@zvr zvr requested a review from bact September 3, 2024 07:49
@bact bact merged commit 9b5080d into spdx:development/v3.0.1 Sep 3, 2024
3 checks passed
@zvr zvr deleted the submissions branch September 6, 2024 08:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci Dev workflow and repo management publishing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants