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

Use non-permalink for HIGHEST_SUPPORTED_K8S_VERSION #424

Merged
merged 3 commits into from
Apr 2, 2024

Conversation

maxrjones
Copy link
Contributor

Reference Issues or PRs

Relates to nebari-dev/nebari#2301, nebari-dev/nebari#2276

What does this implement/fix?

The permalink to an old commit led me down a bit of a rabbit hole through the issues/PRs above to find out Nebari's plans for 1.26's planned EOL (e.g., references above). I think it would make more sense to use a non-permalink so readers are taken to the lastest commit and can see the current maximum supported k8s version. That said, I'm not sure whether the branch should be develop or main (this PR currently uses the default branch of develop).

Put a x in the boxes that apply

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds a feature)
  • Breaking change (fix or feature that would cause existing features not to work as expected)
  • Documentation Update
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no API changes)
  • Build related changes
  • Other (please describe):

Testing

  • Did you test the pull request locally?
  • Did you add new tests?

Documentation

Access-centered content checklist

Text styling

  • The content is written with plain language (where relevant).
  • If there are headers, they use the proper header tags (with only one level-one header: H1 or # in markdown).
  • All links describe where they link to (for example, check the Nebari website).
  • This content adheres to the Nebari style guides.

Non-text content

  • All content is represented as text (for example, images need alt text, and videos need captions or descriptive transcripts).
  • If there are emojis, there are not more than three in a row.
  • Don't use flashing GIFs or videos.
  • If the content were to be read as plain text, it still makes sense, and no information is missing.

Any other comments?

Copy link

netlify bot commented Apr 1, 2024

Deploy Preview for nebari-docs ready!

Name Link
🔨 Latest commit 3f8dd9e
🔍 Latest deploy log https://app.netlify.com/sites/nebari-docs/deploys/660c2ada9aedcb00089f8e96
😎 Deploy Preview https://deploy-preview-424--nebari-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@marcelovilla
Copy link
Member

Nice catch @maxrjones! Thank you for that. I think it would make more sense to point to the main branch as it is consistent with the latest release (develop might have changes that have not been released yet).

@marcelovilla
Copy link
Member

Although I believe the permalink was originally added to make sure we were always linking to that particular line, I think the line numbers in constants.py file do not change that often and readers will benefit to having it linking to the up-to-date version.

@marcelovilla marcelovilla merged commit 02b8620 into nebari-dev:main Apr 2, 2024
6 checks passed
@maxrjones maxrjones deleted the patch-1 branch April 2, 2024 16:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done 💪🏾
Development

Successfully merging this pull request may close these issues.

2 participants