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

Remove candid docs and add to-do for cleanups #42

Merged
merged 3 commits into from
May 23, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions TODO.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# 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)

## Docs requiring changes
- how-to/add_controller (possibly merge add_controller_no_dns into the original)
- how-to/deploy_jimm_k8s
Copy link
Collaborator

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..

- 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
1 change: 1 addition & 0 deletions custom_conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,7 @@
'doc-cheat-sheet*',
'README.md',
'starter-guide.rst',
'TODO.md'
]

# Add CSS files (located in .sphinx/_static/)
Expand Down
4 changes: 4 additions & 0 deletions how-to/add_controller.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
JAAS: Add controller to JIMM
============================

.. warning::
This document has not been updated for JIMM.V3.


Introduction
------------

Expand Down
4 changes: 4 additions & 0 deletions how-to/add_controller_no_dns.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
JAAS: Add controller to JIMM without DNS
========================================

.. warning::
This document has not been updated for JIMM.V3.


Introduction
------------

Expand Down
186 changes: 0 additions & 186 deletions how-to/candid_adfs_integration.rst

This file was deleted.

104 changes: 0 additions & 104 deletions how-to/candid_azure_integration.rst

This file was deleted.

Loading
Loading