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

Point to Guide instead of edge [skip ci] #49552

Merged
merged 1 commit into from Oct 9, 2023

Conversation

akhilgkrishnan
Copy link
Member

Detail

This Pull Request points the guide url instead of edgeguide.

Checklist

Before submitting the PR make sure the following are checked:

  • This Pull Request is related to one change. Changes that are unrelated should be opened in separate PRs.
  • Commit message has a detailed description of what changed and why. If this PR fixes a related issue include it in the commit message. Ex: [Fix #issue-number]
  • Tests are added or updated if you fix a bug or add a feature.
  • CHANGELOG files are updated for the changed libraries if there is a behavior change or additional feature. Minor bug fixes and documentation changes should not be included.

@skipkayhil
Copy link
Member

I confirmed this is the only other case of edge slipping into our docs with this script: https://github.com/skipkayhil/rails-bin/blob/main/bin/check-links

Happy to add this to our CI if a committer thinks its a good idea

@skipkayhil skipkayhil merged commit 1dbd2fa into rails:main Oct 9, 2023
skipkayhil added a commit that referenced this pull request Oct 9, 2023
Point to Guide instead of edge [skip ci]
@akhilgkrishnan akhilgkrishnan deleted the update-edge-guide-url branch October 9, 2023 14:45
@akhilgkrishnan
Copy link
Member Author

@skipkayhil I think we also want to backport this change to 7-1-stable

@akhilgkrishnan
Copy link
Member Author

akhilgkrishnan commented Oct 9, 2023

I confirmed this is the only other case of edge slipping into our docs with this script: https://github.com/skipkayhil/rails-bin/blob/main/bin/check-links

Happy to add this to our CI if a committer thinks its a good idea

But we still need to allow them to add right. Because when were writing those changes, that only appears in edge guides until we do a release.

@skipkayhil
Copy link
Member

skipkayhil commented Oct 9, 2023

But we still need to allow them to add right. Because when were writing those changes, that only appears in edge guides until we do a release.

Ah, right, the section didn't exist before, that makes sense. I guess it's just unfortunate that we have to come back and clean them all up later 😕

@zzak
Copy link
Member

zzak commented Oct 10, 2023

I confirmed this is the only other case of edge slipping into our docs with this script: https://github.com/skipkayhil/rails-bin/blob/main/bin/check-links

@skipkayhil There is already a rake guides:validate which does some HTML validation, I could see us adding a link checker as well.

There was also a similar discussion in Ruby here, maybe it could be built into rdoc:
ruby/rdoc#1007

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants