diff --git a/docs/explanation/charm-architecture.md b/docs/explanation/charm-architecture.md index 9bcee00b..ad48a808 100644 --- a/docs/explanation/charm-architecture.md +++ b/docs/explanation/charm-architecture.md @@ -39,8 +39,6 @@ The OCI image is built using [Rockcraft](https://canonical-rockcraft.readthedocs This is done by publishing a resource to Charmhub as described in the [Juju SDK How-to guides](https://juju.is/docs/sdk/publishing). -The OCI image is currently not made to work in an air-gapped environment. You should make sure that it has access to `https://rubygems.org/` (to install gems) and to `https://avatars.discourse.org/` (the official service to create letter avatars). - ## Integrations ### Ingress @@ -87,4 +85,4 @@ CharmBase is the base class from which all Charms are formed, defined by [Ops](h See more information in [Charm](https://juju.is/docs/sdk/constructs#heading--charm). -The `__init__` method guarantees that the charm observes all events relevant to its operation and handles them. +The `__init__` method guarantees that the charm observes all events relevant to its operation and handles them. \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 36588cf8..f5bffaa5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -29,4 +29,24 @@ fixes and constructive feedback. - [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/discourse-k8s/docs/how-to-contribute) \ No newline at end of file +- [Contribute](https://charmhub.io/discourse-k8s/docs/how-to-contribute) + +# Contents + +1. [Explanation](explanation) + 1. [Charm architecture](explanation/charm-architecture.md) +1. [How To](how-to) + 1. [How to access the Rails console](how-to/access--the-rails-console.md) + 1. [How to configure the container](how-to/configure-container.md) + 1. [How to configure the hostname](how-to/configure-hostname.md) + 1. [How to configure S3](how-to/configure-s3.md) + 1. [How to configure SAML](how-to/configure-saml.md) + 1. [How to configure SMTP](how-to/configure-smtp.md) + 1. [How to contribute](how-to/contribute.md) + 1. [How to upgrade](how-to/upgrade.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. [Getting started](tutorial.md) \ No newline at end of file diff --git a/docs/tutorial.md b/docs/tutorial.md index eb8d840f..9be1d02e 100644 --- a/docs/tutorial.md +++ b/docs/tutorial.md @@ -31,7 +31,7 @@ juju config postgresql-k8s plugin_pg_trgm_enable=True # Relate redis-k8s and postgresql-k8s to discourse-k8s juju relate redis-k8s discourse-k8s -juju relate discourse-k8s postgresql-k8s +juju relate discourse-k8s postgresql-k8s:db ``` @@ -85,4 +85,4 @@ Discourse will be deployed with `discourse-k8s` as default hostname. In order to After that, visit `http://discourse-k8s` to reach Discourse. -This charm allows you to add a admin user by executing the corresponding action. Instead of interacting with the Discourse UI just run `juju run-action discourse-k8s/0 add-admin-user email=email@example.com password=somepwd --wait` and it will be registered and validated. +This charm allows you to add a admin user by executing the corresponding action. Instead of interacting with the Discourse UI just run `juju run-action discourse-k8s/0 add-admin-user email=email@example.com password=somepwd --wait` and it will be registered and validated. \ No newline at end of file