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: recommend users install the GitHub or Bitbucket Cloud hosted app #29457

Conversation

HonkingGoose
Copy link
Collaborator

@HonkingGoose HonkingGoose commented Jun 5, 2024

Changes

  • Add short intro sentence to GitHub and Bitbucket Cloud platform module pages
  • Explain that the hosted app is the easiest way to get started

Context

Closes #29372.

We should point out the easiest way to do things first.

Some users may land on the platform module docs via the ## Supported platform section of the docs homepage, which directly links to the platform module docs:

## Supported Platforms

Renovate works on these platforms:

- [GitHub (.com and Enterprise Server)](./modules/platform/github/index.md)
- [GitLab (.com and CE/EE)](./modules/platform/gitlab/index.md)
- [Bitbucket Cloud](./modules/platform/bitbucket/index.md)
- [Bitbucket Server](./modules/platform/bitbucket-server/index.md)
- [Azure DevOps](./modules/platform/azure/index.md)
- [AWS CodeCommit](./modules/platform/codecommit/index.md)
- [Gitea and Forgejo](./modules/platform/gitea/index.md)
- [Gerrit (experimental)](./modules/platform/gerrit/index.md)

If users follow a link like this, and they end up at a platform which has a hosted app, we should:

  • point out the easiest way first
  • Explain that the info in this docs is mostly meant for self-hosted users. (The issues list for the platform can be relevant to both hosted and self-hosted users).

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

@HonkingGoose HonkingGoose requested a review from rarkins June 5, 2024 15:17
lib/modules/platform/bitbucket/readme.md Outdated Show resolved Hide resolved
lib/modules/platform/bitbucket/readme.md Outdated Show resolved Hide resolved
lib/modules/platform/bitbucket/readme.md Outdated Show resolved Hide resolved
lib/modules/platform/bitbucket/readme.md Outdated Show resolved Hide resolved
lib/modules/platform/bitbucket/readme.md Outdated Show resolved Hide resolved
lib/modules/platform/github/readme.md Outdated Show resolved Hide resolved
lib/modules/platform/github/readme.md Outdated Show resolved Hide resolved
lib/modules/platform/github/readme.md Outdated Show resolved Hide resolved
@HonkingGoose HonkingGoose marked this pull request as ready for review June 6, 2024 12:48
rarkins
rarkins previously approved these changes Jun 12, 2024
lib/modules/platform/bitbucket/readme.md Outdated Show resolved Hide resolved
lib/modules/platform/bitbucket/readme.md Outdated Show resolved Hide resolved
lib/modules/platform/github/readme.md Outdated Show resolved Hide resolved
lib/modules/platform/github/readme.md Outdated Show resolved Hide resolved
Co-authored-by: Michael Kriese <[email protected]>
@rarkins rarkins added this pull request to the merge queue Jun 21, 2024
Merged via the queue into renovatebot:main with commit 2bc6e2d Jun 21, 2024
35 checks passed
@renovate-release
Copy link
Collaborator

🎉 This PR is included in version 37.413.5 🎉

The release is available on:

Your semantic-release bot 📦🚀

@HonkingGoose HonkingGoose deleted the docs/recommend-installing-hosted-app-github-and-bitbucket-cloud branch June 21, 2024 16:15
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 22, 2024
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.

Add Mend app guide to the top of Bitbucket Cloud readme
4 participants