docs: describe intended ways to use Renovate #11197
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
viceice
reviewed
Aug 10, 2021
|
I think this is correctly placed in the "development" side of the docs and complementary |
HonkingGoose
commented
Aug 12, 2021
HonkingGoose
commented
Sep 27, 2021
rarkins
requested changes
Sep 27, 2021
Co-authored-by: Rhys Arkins <rhys@arkins.net>
HonkingGoose
commented
Sep 27, 2021
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
rarkins
approved these changes
Sep 27, 2021
|
馃帀 This PR is included in version 27.19.3 馃帀 The release is available on:
Your semantic-release bot 馃摝馃殌 |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes:
design-decisions.mddocsAdd section to the FAQ for end-users that describes the intended ways to use Renovate bot(Decided to drop this idea!)Context:
Me and @viceice discussed the Renovate API not being stable (#11147).
I discovered we basically don't mention our API being unstable anywhere, we also don't really say to the end-user "Here's the supported ways to use Renovate".
@viceice made the point that it's undocumented for a reason: so that people don't go use the internals of Renovate for their own thing. Also documenting the API is a lot of work, and those API docs would need to be updated regularly.
Basically their point boils down to: "We don't document it anywhere, so people can't use it in bad ways."
I think we should at least mention somewhere suitable that our API is meant for our use only, and that people should only use Renovate as an app. We should also say which ways of using Renovate as an app are supported.
Maybe I'm honking up the wrong tree here, and the Renovate maintainers are happy to leave things as they are. 馃槈
I'll take the risk of a rejected PR, as my point will be clearer to see with a PR than with a new issue that re-hashes the discussion. 馃槃
Documentation (please check one with an [x])
How I've tested my work (please tick one)
I have verified these changes via: