Skip to content

Commit ec38d05

Browse files
authored
Add a TOC to the README (#25)
* add TOC * make top-level headings bold
1 parent e15a92c commit ec38d05

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,22 @@ This repo also contains the source code of a Kubernetes charm for operating the
1212
> To use the dashboard charm in a real Juju deployment, see [TODO: docs on Charmhub] instead of this repo.
1313
> This repo is the right place to look if you'd like to test the charm, customise it for your own purposes, or contribute to development!
1414
15+
In this README:
16+
17+
- **[Deploy the dashboard on your machine](#deploy-the-dashboard-on-your-machine)**
18+
- [Prepare your environment](#prepare-your-environment)
19+
- [Create a container image for the application](#create-a-container-image-for-the-application)
20+
- [Create a charm](#create-a-charm)
21+
- [Deploy the dashboard charm](#deploy-the-dashboard-charm)
22+
- [Configure the dashboard](#configure-the-dashboard)
23+
- [Deploy a PostgreSQL charm](#deploy-a-postgresql-charm)
24+
- [Wait for the charms to finish deploying](#wait-for-the-charms-to-finish-deploying)
25+
- [Integrate the dashboard with PostgreSQL](#integrate-the-dashboard-with-postgresql)
26+
- [Check the status of the dashboard](#check-the-status-of-the-dashboard)
27+
- [Open the dashboard in your browser](#open-the-dashboard-in-your-browser)
28+
- [Explore further](#explore-further)
29+
- **[Simulate a production deployment](#simulate-a-production-deployment)** (work in progress)
30+
1531
## Deploy the dashboard on your machine
1632

1733
### Prepare your environment

0 commit comments

Comments
 (0)