-
Notifications
You must be signed in to change notification settings - Fork 2.4k
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
docs: improve Getting Started #11202
Conversation
My intention is that the Getting Started section starts with Use Cases, then proceeds to a page which explains that you need to host it yourself if you're not on github.com or don't already have someone doing it for you. Then a dedicated page for self-hosters, one for the hosted app, and then into how onboarding works |
I'm glad we're improving the introductory documentation! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like this a lot, it's easy to read and understand. Even I am learning new stuff here! 😄
There are some small things we need to change though. 😉
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some capitalization changes, and some other small stuff to maybe change.
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
@HonkingGoose hope you don't mind me hitting you with so much to review at once, but I figured I will need to update the website menus anyway so may as well try to do as much as possible in one go |
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
I'll have time to review tomorrow. 😉 So feel free to change things around on this branch until then. 😄 |
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
First batch of review comments.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Second batch of review
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
This comment has been minimized.
This comment has been minimized.
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Manually checked the links in the documents.
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Found more links that need to be changed.
The best thing is probably for you do a search for a snippet of the removed/renamed filenames, to find links that need updating.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I checked our Markdown and TypeScript files for links which have a portion of the removed/renamed files in them, and I think we updated all of our broken links, or at least most of them... 😄
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd say we're good to go. I've done all the reviewing that I can on this, and I'm reasonably confident that things will work well enough to try merging. We'll need to check the images and links by hand on the production site though, to be sure everything works.
Maybe we should do the suggestion from @viceice in to "recommend Helm charts for Kubernetes" in a separate PR once this lands on the main
branch, or we'll keep ballooning this PR's size. 😄
Remember to update the sidebar on the auto-generating docs repository. Or the new pages might be hard to find without knowing the URL. 😄
not sure why we have a snapshot failure? |
I'll merge this tomorrow because the docs repo will need immediate updating afterwards |
🎉 This PR is included in version 25.72.2 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
Changes:
Adds a new "Use Cases" document, to be added as first read in Getting Started.
Context:
Renovate can be hard to understand for a newcomer, and this attempts to help people who like to think in Use Cases.
Documentation (please check one with an [x])
How I've tested my work (please tick one)
I have verified these changes via: