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(index): explain who these docs are for #30039

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

HonkingGoose
Copy link
Collaborator

Changes

  • Explain to incoming readers:
    • That the main Renovate docs are meant for the Renovate Open Source CLI, and the Mend-hosted GitHub App
    • Where to find the correct docs for each Renovate variant
    • If you use a variant, read the variant docs first, then come back and read the main docs, as many concepts/ideas/features/config/etc applies to variants too

Context

A user followed the correct steps, from the wrong docs. When Renovate errored out, the user asked for help, and got pointed to the correct docs:

I hope to prevent such confusion by clearly stating on the homepage if the user is in the right place, or not.

Location of new content to be decided together

I can't really find a good place (on the current homepage) to put the new info.

The current homepage is mostly marketing/selling the Renovate tool. So putting a boring section about "Am I reading the right docs" will always look bad, no matter where I put it.

We really need to focus the homepage (and readme)

Again, I'm hitting the problem that the homepage tries too much at once. Focusing the homepage (and repo readme) will make it easier for me to put new content in, and have it look good.

I created this issue, which is waiting for an official go/no-go from @rarkins as the Mend team are still deciding on the correct todos:

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 select 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

Comment on lines +23 to +26
| Renovate Community Edition (CE) | link to correct docs |
| Renovate Enterprise Edition (EE) | link to correct docs |
| Mend app for Bitbucket Cloud | link to correct docs |
| Mend app for Bitbucket Cloud with Mend's full AppSec solution (SCA, SAST, etc) | link to correct docs |
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can a Mend maintainer suggest the right links to the Mend-only docs?

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

Successfully merging this pull request may close these issues.

None yet

1 participant