Updates the Install Minder Server documentation #3880
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
Updated the docs for installation Fixes #3835
|
|
jhrozek
reviewed
Jul 15, 2024
evankanderson
previously approved these changes
Jul 15, 2024
Co-authored-by: Evan Anderson <evan@stacklok.com>
Co-authored-by: Evan Anderson <evan@stacklok.com>
Co-authored-by: Evan Anderson <evan@stacklok.com>
Co-authored-by: Evan Anderson <evan@stacklok.com>
Co-authored-by: Evan Anderson <evan@stacklok.com>
Co-authored-by: Evan Anderson <evan@stacklok.com>
Co-authored-by: Evan Anderson <evan@stacklok.com>
Co-authored-by: Evan Anderson <evan@stacklok.com>
Co-authored-by: Evan Anderson <evan@stacklok.com>
jhrozek
approved these changes
Jul 17, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Updated the docs for installing Minder server
After talking with Evan, decided to focus on what we thought were the 2 main use cases for installing Minder server: development and production. I left the production docs (Install using Helm) alone except for minor title change.
For the development install, I tried to streamline the process, leading the user down a single path for installation (instead of giving them 5 different ways to do it), provide more clarity, and add screenshots.
The other major change is focusing solely on using a GitHub App as the provider and a breaking out the OAuth steps into a legacy doc that does not get referred to.
Fixes #3835
Summary
Provide a brief overview of the changes and the issue being addressed.
Explain the rationale and any background necessary for understanding the changes.
List dependencies required by this change, if any.
Fixes #(related issue)
Change Type
Mark the type of change your PR introduces:
Testing
Outline how the changes were tested, including steps to reproduce and any relevant configurations.
Attach screenshots if helpful.
Review Checklist: