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

Adds 8knot oauth usage documentation #705

Merged
merged 2 commits into from
Apr 26, 2024
Merged

Conversation

JamesKunstle
Copy link
Contributor

have needed to document the usage of oauth in 8Knot for a while. this gives an overview of the files and steps involved
in authenticating user access to groups, and notes gaps in the implementation.

Signed-off-by: James Kunstle [email protected]

@JamesKunstle
Copy link
Contributor Author

closes #485

Copy link
Collaborator

@cdolfi cdolfi left a comment

Choose a reason for hiding this comment

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

Overall looks great, just one small change. Also, add a reference to this in the readme and get the precommit to pass

@@ -0,0 +1,38 @@
# How do user accounts work in 8Knot (OAuth and session handling)

8Knot obviously uses some notion of a user account- there are log in / log out buttons, and user groups are persist across logins.
Copy link
Collaborator

Choose a reason for hiding this comment

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

"8Knot uses some notion of a user account - there..." or something like that. "Obviously" can come off wrong for new people who this might not be obvious for

Copy link
Contributor Author

Choose a reason for hiding this comment

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

++

@JamesKunstle JamesKunstle force-pushed the oauth-docs branch 2 times, most recently from 46c232a to 6f82430 Compare April 25, 2024 14:54
@JamesKunstle
Copy link
Contributor Author

@cdolfi

Copy link
Collaborator

@cdolfi cdolfi left a comment

Choose a reason for hiding this comment

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

lgtm

@cdolfi cdolfi merged commit 073479b into oss-aspen:dev Apr 26, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

2 participants