docs: Updated README with a full revamp #31614
Conversation
|
|
||
| - Delivers update PRs directly to your repo | ||
| - Relevant package files are discovered automatically | ||
| - Pull Requests automatically generated in your repo |
There was a problem hiding this comment.
| - Pull Requests automatically generated in your repo |
This duplicates information from the first list item: Delivers update PRs directly to your repo.
There was a problem hiding this comment.
I see your point. The heading is a summary and this bullet point fleshes it out in more detail.
| - Delivers update PRs directly to your repo | ||
| - Relevant package files are discovered automatically | ||
| - Pull Requests automatically generated in your repo | ||
| - Provides useful information to help you decide which updates to accept (age, adoption, pass rates, merge confidence) |
There was a problem hiding this comment.
| - Provides useful information to help you decide which updates to accept (age, adoption, pass rates, merge confidence) | |
| - Renovate's PRs have badges to help you decide if you want to update: | |
| - The age of the package update | |
| - How many of the Mend-hosted app users updated to this version of the package | |
| - The test pass rates for Mend-hosted app users | |
| - A merge confidence score, that combines all the info above into a single number |
There was a problem hiding this comment.
For the page re-write, I went with an approach to reduce the overall page height by deliberately collapsing bulleted lists into comma-separated strings. It's an overview page and doesn't really need to explain every detail about the badges, IMHO.
|
|
||
| For Bitbucket Cloud, Bitbucket Server, Forgejo, Gitea and GitLab, use our self-hosting option. | ||
| We prefer all items to be opened as a discussion before opening an issue. |
There was a problem hiding this comment.
| We prefer all items to be opened as a discussion before opening an issue. | |
| Please open a Discussion, to get help, suggest a new feature, or to report a bug. | |
| We only want maintainers to open Issues. |
How about this?
There was a problem hiding this comment.
Thanks for the suggestion. I'll think about this one.
In any event, can you please remove the comma after "Discussion".
|
|
||
| ## Contributing | ||
| Follow us on Twitter, LinkedIn and Mastodon. |
There was a problem hiding this comment.
| Follow us on Twitter, LinkedIn and Mastodon. | |
| Follow us on: |
There was a problem hiding this comment.
I don't really like adding colons to a list heading.
| If you want to contribute to Renovate or get a local copy running, please read the instructions in [contributing guidelines](.github/contributing.md). | ||
| To get started look at the [list of good first issues](https://github.com/renovatebot/renovate/contribute). | ||
| - Twitter: [x.com/mend_io](http://x.com/mend_io) | ||
| - LinkedIn: [linkedin.com/company/mend-io](https://linkedin.com/company/mend-io) |
There was a problem hiding this comment.
The list is missing the Mastodon contact info. 😉
There was a problem hiding this comment.
Removed the detail from the list heading per your suggestion. Thanks
Co-authored-by: HonkingGoose <[email protected]>
Changes
Updated README with a full revamp.
Context
Restructuring the README file for better readability and reference to the various ways to run Renovate.
Documentation (please check one with an [x])
How I've tested my work (please select one)
I have verified these changes via: