[discourse-gatekeeper] Migrate charm docs

docs/explanation/charm-architecture.md

@@ -103,4 +103,4 @@ juju config synapse server_name=myserver.myserver.com
 self.framework.observe(self.on.config_changed, self._on_config_changed)
 4. The method `_on_config_changed` will take the necessary actions. 
 The actions include waiting for all the relations to be ready and then configuring
-the containers.
+the containers.

docs/how-to/contribute.md

@@ -116,4 +116,4 @@ Read more about server_name in [Configuring Synapse](https://matrix-org.github.i
 
 ## Canonical Contributor Agreement
 
-Canonical welcomes contributions to the Synapse Operator. Please check out our [contributor agreement](https://ubuntu.com/legal/contributors) if you're interested in contributing to the solution.
+Canonical welcomes contributions to the Synapse Operator. Please check out our [contributor agreement](https://ubuntu.com/legal/contributors) if you're interested in contributing to the solution.

docs/index.md

@@ -1,33 +1,36 @@
-# Synapse Operator
+A Juju charm deploying and managing [Synapse](https://github.com/matrix-org/synapse) on Kubernetes. Synapse is a drop in replacement for other chat servers like Mattermost and Slack.
 
-A Juju charm deploying and managing [Synapse](https://github.com/matrix-org/synapse) on Kubernetes.
-Synapse is a drop in replacement for other chat servers like Mattermost and
-Slack.
+This charm simplifies initial deployment and "day N" operations of Synapse on Kubernetes, such as 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) to [Charmed Kubernetes](https://ubuntu.com/kubernetes) to public cloud Kubernetes offerings.
 
-This charm simplifies initial deployment and “day N” operations of Synapse on
-Kubernetes, such as 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) to [Charmed Kubernetes](https://ubuntu.com/kubernetes)
-to public cloud Kubernetes offerings.
+As such, the charm makes it easy for those looking to take control of their own Chat server whilst keeping operations simple, and gives them the freedom to deploy on the Kubernetes platform of their choice.
 
-As such, the charm makes it easy for those looking to take control of their own
-Chat server whilst keeping operations simple, and gives them the freedom to
-deploy on the Kubernetes platform of their choice.
-
-For DevOps or SRE teams this charm will make operating Synapse simple and
-straightforward through Juju’s clean interface. It will allow easy deployment
-into multiple environments for testing of changes.
+For DevOps or SRE teams this charm will make operating Synapse simple and straightforward through Juju's clean interface. It will allow easy deployment into multiple environments for testing of changes.
 
 ## Project and community
 
-The Synapse Operator is a member of the Ubuntu family. It's an open source
-project that warmly welcomes community projects, contributions, suggestions,
-fixes and constructive feedback.
+Synapse is an open-source project that welcomes community contributions, suggestions, fixes and constructive feedback.
+
+* [Read our Code of Conduct](https://ubuntu.com/community/code-of-conduct)
+* [Join the Discourse forum](https://discourse.charmhub.io/tag/synapse)
+* [Discuss on the Mattermost chat service](https://chat.charmhub.io/charmhub/channels/charm-dev)
+* Contribute and report bugs to [the Synapse operator](https://github.com/canonical/synapse-operator)
+* Check the [release notes](https://github.com/canonical/synapse-operator/releases)
+
+## Contributing to this documentation
+
+Documentation is an important part of this project, and we take the same open-source approach to the documentation as the code. As such, we welcome community contributions, suggestions and constructive feedback on our documentation. Our documentation is hosted on the [Charmhub forum](https://discourse.charmhub.io/) to enable easy collaboration. Please use the “Help us improve this documentation” links on each documentation page to either directly change something you see that’s wrong, or ask a question, or make a suggestion about a potential change via the comments section.
+
+If there’s a particular area of documentation that you’d like to see that’s missing, please [file a bug](https://github.com/canonical/synapse-operator/issues).
 
-- [Code of conduct](https://ubuntu.com/community/code-of-conduct)
-- [Get support](https://discourse.charmhub.io/)
-- [Join our online chat](https://chat.charmhub.io/charmhub/channels/charm-dev)
-- [Contribute](https://charmhub.io/synapse/docs/how-to-contribute)
+# Contents
 
-Thinking about using the Synapse Operator for your next project?
-[Get in touch](https://chat.charmhub.io/charmhub/channels/charm-dev)!
+1. [Tutorial](tutorial)
+  1. [Getting Started](tutorial/getting-started.md)
+1. [How to](how-to)
+  1. [Contribute](how-to/contribute.md)
+1. [Reference](reference)
+  1. [Actions](reference/actions.md)
+  1. [Integrations](reference/integrations.md)
+1. [Explanation](explanation)
+  1. [Charm architecture](explanation/charm-architecture.md)

docs/reference/actions.md

@@ -1,3 +1,3 @@
 # Actions
 
-See [Actions](https://charmhub.io/synapse/actions).
+See [Actions](https://charmhub.io/synapse/actions).

docs/reference/integrations.md

@@ -73,4 +73,4 @@ Note that `public_baseurl` configuration set the public-facing base URL that
 clients use to access this Homeserver. It's used as `entity_id` if set instead of
 https://server_name.
 
-See more information in [Charm Architecture](https://charmhub.io/synapse/docs/explanation-charm-architecture).
+See more information in [Charm Architecture](https://charmhub.io/synapse/docs/explanation-charm-architecture).

docs/tutorial/getting-started.md

@@ -140,4 +140,4 @@ model environment you created during this tutorial, use the following command.
 
 ```
 juju destroy model synapse-tutorial -y
-```
+```