From 5b8cfddd335e571a3369b04e7e4679179b857631 Mon Sep 17 00:00:00 2001 From: Erin Conley Date: Tue, 1 Oct 2024 09:46:34 -0400 Subject: [PATCH] Update index.md (#294) * Update index.md (ISD-2212 and ISD-2289) Adopted template page (in this case, added header to the page) Rearranged the Contents section so the left-hand Charmhub menu will have a consistent pattern Smaller edits to text * clarify --- docs/index.md | 28 +++++++++++++++++----------- 1 file changed, 17 insertions(+), 11 deletions(-) diff --git a/docs/index.md b/docs/index.md index 47759b92..499371e4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,11 +1,17 @@ -This charm simplifies initial deployment and "day N" operations of Discourse -on Kubernetes, such as scaling the number of instances, integration with SSO, -access to S3 for redundant file storage and more. It allows for deployment on -many different Kubernetes platforms, from [MicroK8s](https://microk8s.io) or -[Charmed Kubernetes](https://ubuntu.com/kubernetes) to public cloud Kubernetes -offerings. +# Discourse Operator +A [Juju](https://juju.is/) [charm](https://juju.is/docs/olm/charmed-operators) deploying and managing Discourse on Kubernetes. -Discourse is an open-source software application used to create customer-friendly and community-friendly discussion platforms, forums, and mailing lists. It's designed to work as a discussion platform for various topics and is widely used by numerous organizations and individuals to build communities, provide customer support, and facilitate conversations. The platform is built with a focus on simplicity, user-friendliness, and responsiveness, making it accessible from both desktops and mobile devices. Discourse provides various moderation and administration tools, enabling community managers to maintain a healthy and constructive environment. +Discourse is an open-source software application used to create customer-friendly and community-friendly discussion platforms, +forums, and mailing lists. It's designed to work as a discussion platform for various topics and is widely used by numerous +organizations and individuals to build communities, provide customer support, and facilitate conversations. The platform is +built with a focus on simplicity, user-friendliness, and responsiveness, making it accessible from both desktops and mobile +devices. Discourse provides various moderation and administration tools, enabling community managers to maintain a healthy and +constructive environment. + +This charm simplifies operations of Discourse on Kubernetes, such as scaling the number of instances, integration +with SSO, access to S3 for redundant file storage and more. It allows for deployment on many different Kubernetes +platforms, from [MicroK8s](https://microk8s.io) or [Charmed Kubernetes](https://ubuntu.com/kubernetes) to public cloud +Kubernetes offerings. ## In this documentation @@ -33,10 +39,10 @@ fixes and constructive feedback. # Contents -1. [Explanation](explanation) - 1. [Charm architecture](explanation/charm-architecture.md) +1. [Tutorial](tutorial.md) 1. [How To](how-to) 1. [Access the Rails console](how-to/access--the-rails-console.md) + 1. [Backup and restore](how-to/backup-and-restore.md) 1. [Configure the container](how-to/configure-container.md) 1. [Configure the hostname](how-to/configure-hostname.md) 1. [Configure S3](how-to/configure-s3.md) @@ -44,11 +50,11 @@ fixes and constructive feedback. 1. [Configure SMTP](how-to/configure-smtp.md) 1. [Contribute](how-to/contribute.md) 1. [Upgrade](how-to/upgrade.md) - 1. [Backup and restore](how-to/backup-and-restore.md) 1. [Reference](reference) 1. [Actions](reference/actions.md) 1. [Configurations](reference/configurations.md) 1. [Integrations](reference/integrations.md) 1. [Plugins](reference/plugins.md) 1. [External Access](reference/external-access.md) -1. [Getting started](tutorial.md) +1. [Explanation](explanation) + 1. [Charm architecture](explanation/charm-architecture.md)