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.

Sign up for GitHub

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

[discourse-gatekeeper] Migrate charm docs #150

Merged
merged 7 commits into from
Jan 16, 2024
Merged

[discourse-gatekeeper] Migrate charm docs #150

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
48ed7ae
modified: docs/explanation/charm-architecture.md,docs/index.md,docs/t…
github-actions[bot] Dec 1, 2023
4f4730e
Merge branch 'main' into discourse-gatekeeper/migrate
merkata Dec 12, 2023
a09b999
Merge branch 'main' into discourse-gatekeeper/migrate
merkata Jan 3, 2024
8dfd565
Merge branch 'main' into discourse-gatekeeper/migrate
merkata Jan 10, 2024
b6d6141
Merge branch 'main' into discourse-gatekeeper/migrate
merkata Jan 15, 2024
5dbadcf
modified: docs/index.md
github-actions[bot] Jan 16, 2024
cf4456c
Merge branch 'main' into discourse-gatekeeper/migrate
merkata Jan 16, 2024
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
4 changes: 1 addition & 3 deletions docs/explanation/charm-architecture.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
22 changes: 21 additions & 1 deletion docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
- [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)
4 changes: 2 additions & 2 deletions docs/tutorial.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

```

Expand Down Expand Up @@ -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 protected] 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 protected] password=somepwd --wait` and it will be registered and validated.
Loading