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

docs: improve Getting Started #11202

Merged
merged 23 commits into from
Aug 12, 2021
Merged

docs: improve Getting Started #11202

merged 23 commits into from
Aug 12, 2021

Conversation

rarkins
Copy link
Collaborator

@rarkins rarkins commented Aug 10, 2021

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])

  • I have updated the documentation, or
  • No documentation update is required

How I've tested my work (please tick one)

I have verified these changes via:

  • Code inspection only, or
  • Newly added/modified unit tests, or
  • No unit tests but ran on a real repository, or
  • Both unit tests + ran on a real repository

@rarkins rarkins requested a review from HonkingGoose August 10, 2021 10:05
@rarkins
Copy link
Collaborator Author

rarkins commented Aug 10, 2021

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

@HonkingGoose
Copy link
Collaborator

I'm glad we're improving the introductory documentation!

Copy link
Collaborator

@HonkingGoose HonkingGoose left a 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. 😉

docs/usage/getting-started/use-cases.md Outdated Show resolved Hide resolved
docs/usage/getting-started/use-cases.md Outdated Show resolved Hide resolved
docs/usage/getting-started/use-cases.md Outdated Show resolved Hide resolved
docs/usage/getting-started/use-cases.md Outdated Show resolved Hide resolved
docs/usage/getting-started/use-cases.md Outdated Show resolved Hide resolved
docs/usage/getting-started/use-cases.md Outdated Show resolved Hide resolved
docs/usage/getting-started/use-cases.md Outdated Show resolved Hide resolved
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
docs/usage/getting-started/use-cases.md Outdated Show resolved Hide resolved
docs/usage/getting-started/use-cases.md Outdated Show resolved Hide resolved
docs/usage/getting-started/use-cases.md Show resolved Hide resolved
docs/usage/getting-started/use-cases.md Outdated Show resolved Hide resolved
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Copy link
Collaborator

@HonkingGoose HonkingGoose left a 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.

docs/usage/getting-started/use-cases.md Outdated Show resolved Hide resolved
docs/usage/getting-started/use-cases.md Outdated Show resolved Hide resolved
docs/usage/getting-started/use-cases.md Outdated Show resolved Hide resolved
docs/usage/getting-started/use-cases.md Outdated Show resolved Hide resolved
docs/usage/getting-started/use-cases.md Outdated Show resolved Hide resolved
docs/usage/getting-started/use-cases.md Outdated Show resolved Hide resolved
docs/usage/getting-started/use-cases.md Outdated Show resolved Hide resolved
docs/usage/getting-started/use-cases.md Outdated Show resolved Hide resolved
docs/usage/getting-started/use-cases.md Outdated Show resolved Hide resolved
docs/usage/getting-started/use-cases.md Outdated Show resolved Hide resolved
rarkins and others added 3 commits August 10, 2021 13:56
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
@rarkins rarkins changed the title docs: use cases docs: improve Getting Started Aug 10, 2021
docs/usage/getting-started/20-running.md Outdated Show resolved Hide resolved
docs/usage/getting-started/20-running.md Outdated Show resolved Hide resolved
docs/usage/getting-started/20-running.md Outdated Show resolved Hide resolved
docs/usage/getting-started/20-running.md Outdated Show resolved Hide resolved
docs/usage/getting-started/20-running.md Outdated Show resolved Hide resolved
docs/usage/getting-started/20-running.md Outdated Show resolved Hide resolved
docs/usage/getting-started/20-running.md Outdated Show resolved Hide resolved
@rarkins
Copy link
Collaborator Author

rarkins commented Aug 10, 2021

@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>
@HonkingGoose
Copy link
Collaborator

I'll have time to review tomorrow. 😉 So feel free to change things around on this branch until then. 😄

@rarkins

This comment has been minimized.

Copy link
Collaborator

@HonkingGoose HonkingGoose left a 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.

docs/usage/getting-started/installing-onboarding.md Outdated Show resolved Hide resolved
docs/usage/getting-started/installing-onboarding.md Outdated Show resolved Hide resolved
docs/usage/getting-started/installing-onboarding.md Outdated Show resolved Hide resolved
docs/usage/getting-started/installing-onboarding.md Outdated Show resolved Hide resolved
docs/usage/getting-started/installing-onboarding.md Outdated Show resolved Hide resolved
docs/usage/getting-started/installing-onboarding.md Outdated Show resolved Hide resolved
docs/usage/getting-started/installing-onboarding.md Outdated Show resolved Hide resolved
docs/usage/getting-started/private-packages.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@HonkingGoose HonkingGoose left a 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

docs/usage/getting-started/running.md Outdated Show resolved Hide resolved
docs/usage/getting-started/running.md Outdated Show resolved Hide resolved
docs/usage/getting-started/running.md Outdated Show resolved Hide resolved
docs/usage/getting-started/running.md Outdated Show resolved Hide resolved
docs/usage/getting-started/running.md Outdated Show resolved Hide resolved
docs/usage/getting-started/running.md Outdated Show resolved Hide resolved
docs/usage/getting-started/running.md Outdated Show resolved Hide resolved
docs/usage/getting-started/running.md Outdated Show resolved Hide resolved
docs/usage/getting-started/running.md Outdated Show resolved Hide resolved
docs/usage/getting-started/running.md Outdated Show resolved Hide resolved
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
@HonkingGoose

This comment has been minimized.

docs/usage/getting-started/use-cases.md Show resolved Hide resolved
docs/usage/getting-started/use-cases.md Outdated Show resolved Hide resolved
@rarkins rarkins requested a review from HonkingGoose August 11, 2021 09:45
Copy link
Collaborator

@HonkingGoose HonkingGoose left a 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.

docs/usage/getting-started/running.md Outdated Show resolved Hide resolved
docs/usage/getting-started/running.md Show resolved Hide resolved
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Copy link
Collaborator

@HonkingGoose HonkingGoose left a 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.

docs/usage/examples/self-hosting.md Show resolved Hide resolved
Copy link
Collaborator

@HonkingGoose HonkingGoose left a 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... 😄

@HonkingGoose HonkingGoose self-requested a review August 11, 2021 13:37
HonkingGoose
HonkingGoose previously approved these changes Aug 11, 2021
Copy link
Collaborator

@HonkingGoose HonkingGoose left a 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. 😄

viceice
viceice previously approved these changes Aug 11, 2021
@viceice
Copy link
Member

viceice commented Aug 11, 2021

not sure why we have a snapshot failure?

@rarkins rarkins dismissed stale reviews from viceice and HonkingGoose via b0fea4e August 11, 2021 16:01
@rarkins
Copy link
Collaborator Author

rarkins commented Aug 11, 2021

I'll merge this tomorrow because the docs repo will need immediate updating afterwards

@rarkins rarkins merged commit 594e6e4 into main Aug 12, 2021
@rarkins rarkins deleted the docs/getting-started-use-cases branch August 12, 2021 11:14
@renovate-release
Copy link
Collaborator

🎉 This PR is included in version 25.72.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 12, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants