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

gh-pages: no download link for "latest" schema #4133

Merged
merged 3 commits into from
Oct 14, 2024

Conversation

ralfhandl
Copy link
Contributor

@ralfhandl ralfhandl commented Oct 11, 2024

This comment suggests that

we should not have a "latest" schema symlink because refining the constraints to be more accurate could cause automated systems to suddenly invalidate previously-valid OADs which is not a nice thing to do

The wrapper markdown page for the "view" links now has the same name as the schema file it wraps and the latest symlinks have been removed.

Note

The new publishing process MUST rename the wrapper markdown pages for date-named schema files to match the most recent schema file.

Now:
image

With this PR:
image

Preview: https://ralfhandl.github.io/OpenAPI-Specification/

@ralfhandl ralfhandl requested review from handrews and a team October 11, 2024 13:34
@ralfhandl ralfhandl changed the title gp-pages: no download link for "latest" schema gh-pages: no download link for "latest" schema Oct 11, 2024
@handrews
Copy link
Member

@ralfhandl I'm a bit confused as the preview still has lots of "latest" links that go to latest.html files?

@ralfhandl
Copy link
Contributor Author

Updated the PR description:

  • The "view latest" link remains, it leads to an HTML page with a syntax-colored code block
  • The download link named "latest" is removed, and only the download links for the date-named files remain

handrews
handrews previously approved these changes Oct 12, 2024
Copy link
Member

@handrews handrews left a comment

Choose a reason for hiding this comment

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

@ralfhandl thanks- I'm approving this because it does what it says it does, and that's definitely an improvement! :-)

I do ask why we're using a "latest" link even for the HTML pages rather than just using the latest date as that link. I feel like having a "latest" HTML link will encourage people to look for a "latest" schema, while a design like:

would set the users' expectations more accurately through the use of a date as the link name plus a filename of schema/2022-10-07.html (or whatever is appropriate for including the date). But if there's interest in discussing this further, we can do that in another issue if you'd like.

@ralfhandl
Copy link
Contributor Author

ralfhandl commented Oct 14, 2024

@handrews: removed latest symlinks.

Copy link
Contributor

@mikekistler mikekistler 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. 👍

Copy link
Member

@handrews handrews left a comment

Choose a reason for hiding this comment

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

Thanks @ralfhandl !

@handrews handrews merged commit 0c3a4ef into OAI:gh-pages Oct 14, 2024
@ralfhandl ralfhandl deleted the gh-pages-no-latest-download branch October 15, 2024 09:02
karenetheridge added a commit to karenetheridge/OpenAPI-Modern that referenced this pull request Oct 20, 2024
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.

3 participants