chore(docs): make external auth docs easier to follow #12970
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
|
CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅ |
doodzik
changed the title
|
I have read the CLA Document and I hereby sign the CLA |
cdrcommunity
added a commit
to coder/cla
that referenced
this pull request
Apr 16, 2024
kylecarbs
requested changes
Apr 16, 2024
doodzik
commented
Apr 16, 2024
Co-authored-by: Kyle Carberry <kyle@carberry.com>
doodzik
commented
Apr 16, 2024
|
@kylecarbs great suggestions! I applied them 👍 I also changed |
|
@doodzik thank you for this contribution! let's keep the GitHub App flow for now, it's working well from my testing. |
|
@doodzik could you apply this patch to fix the formatting? https://gist.github.com/kylecarbs/9787881a96bd75aaba7a261610390b89 |
|
@kylecarbs Applied the diff. Can you run the CI step again? |
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.
I was working with @ericpaulsen on setting up Coder. I found the external auth documentation confusing for a first-time reader, so I changed the docs a tiny bit to make it easier to follow.
I also added a k8s environment variable setup section because converting the environment variable to the k8s environment variables was annoying. Now, it can be copy and pasted.
@ericpaulsen, In our call you mentioned that you prefer using GitHub OAuth applications for external auth. Would you like me to switch the docs to use the OAuth application setup proccess instead of the GitHub App one?