-
Notifications
You must be signed in to change notification settings - Fork 7
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
Remove candid docs and add to-do for cleanups #42
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# Description | ||
|
||
The following document describes missing JAAS documentation as well as any docs that need to be modernized. | ||
|
||
## Missing Docs | ||
- Deploy JAAS tutorial (including going all the way to adding a controller, model and application) | ||
- JAAS architecture | ||
- Explain the difference between Juju, JAAS and jimmctl CLI tools. | ||
- Auth doc explaining JIMM's authentication and authorization. | ||
- How to enable/deploy/use the dashboard. | ||
- JAAS Limitations - potentially (As an example, cross-controller relations don't work with JAAS currently) | ||
- Relating JIMM and COS stack - general observability. | ||
- What versions of Juju controllers and CLI does JIMM support. | ||
- Managing access rights via jimmctl | ||
- How to migrate existing Juju controllers and models to JAAS. | ||
- How to bootstrap JAAS with an admin user and create user permissions. | ||
- How to migrate models between Juju controllers in JAAS. | ||
|
||
## Docs requiring changes | ||
- how-to/add_controller (possibly merge add_controller_no_dns into the original) | ||
- how-to/deploy_jimm_k8s | ||
- how-to/deploy_jimm (the machine charm is not currently on par with the k8s charm, this document could be removed until the machine charm is updated and ready for production use) | ||
- how-to/route53 ensure this document is still up to date. | ||
- tutorial/jaas_basics |
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
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
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
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this feels like a tutorial, really.. as does the one below..