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: ensure "rafiki admin auth optional" is documented adequately #2963

Closed
melissahenderson opened this issue Sep 11, 2024 · 0 comments · Fixed by #3016
Closed

docs: ensure "rafiki admin auth optional" is documented adequately #2963

melissahenderson opened this issue Sep 11, 2024 · 0 comments · Fixed by #3016
Assignees
Labels
user-doc-priority: medium User doc priority is medium user-docs

Comments

@melissahenderson
Copy link
Contributor

The purpose of this issue is to ensure the documentation appropriately covers #2883 and the related comments made here: #2875 (comment) (summary of comments below).

Auth/Kratos is currently optional. In the local playground, Kratos is explicitly disabled, which is something we need to mention because it could be confusing to talk about registering users when most people won't encounter that step. For users who want to explore what auth is like locally, they'd run a separate command:
pnpm localenv:compose:adminauth up

Outside of the local playground, Auth/Kratos is enabled by default. This is something we should mention in the Rafiki Admin user guide. Something along the lines of "Here is the auth info. We advise you to use it, but if you want, you can disable it."

One or more pages in the user docs and READMEs may need updating.

@github-project-automation github-project-automation bot moved this to Backlog in Rafiki Sep 11, 2024
@melissahenderson melissahenderson added the user-doc-priority: medium User doc priority is medium label Sep 30, 2024
@brad-dow brad-dow moved this from Backlog to In Progress in Rafiki Oct 2, 2024
@brad-dow brad-dow moved this from In Progress to Ready for Review in Rafiki Oct 3, 2024
@brad-dow brad-dow moved this from In Progress to Ready for Review in Documentation Oct 3, 2024
@github-project-automation github-project-automation bot moved this from Ready for Review to Done in Rafiki Oct 4, 2024
@github-project-automation github-project-automation bot moved this from Ready for Review to Done in Documentation Oct 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
user-doc-priority: medium User doc priority is medium user-docs
Projects
Status: Done
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants