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.

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 #292

Closed
wants to merge 9 commits into from
2 changes: 1 addition & 1 deletion docs/how-to/access--the-rails-console.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ If the output of the last command contains something similar to this:
Loading production environment (Rails 7.0.5.1)
irb(main):001:0>
```
Congratulations, you have accessed the rails console.
Congratulations, you have accessed the rails console.
2 changes: 1 addition & 1 deletion docs/how-to/backup-and-restore.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,4 +54,4 @@ but it is not explained in this How-to.
If the S3 bucket used in the restored Discourse is not the same bucket as the original one, extra steps must be
done, see [moving from one S3 bucket to another](https://meta.discourse.org/t/moving-from-one-s3-bucket-to-another/184779)
for more information. You can run the remap command with: `juju ssh --container discourse discourse-k8s/0 pebble exec --context=discourse --user=_daemon_ -w=/srv/discourse/app/ -- bundle exec /srv/discourse/app/script/discourse backup`
and rake tasks with a command like: `juju ssh --container discourse discourse-k8s/0 pebble exec --context=discourse --user=_daemon_ -w=/srv/discourse/app/ -- bundle exec rake posts:rebake`.
and rake tasks with a command like: `juju ssh --container discourse discourse-k8s/0 pebble exec --context=discourse --user=_daemon_ -w=/srv/discourse/app/ -- bundle exec rake posts:rebake`.
2 changes: 1 addition & 1 deletion docs/how-to/configure-container.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ This charm exposes several configurations to tweak the behaviour of Discourse. T
* The developer mails can be set through [developer_emails](https://charmhub.io/discourse-k8s/configure#developer_emails)
* Throttle level protections provided by Discourse can be changed via [throttle_level](https://charmhub.io/discourse-k8s/configure#throttle_level)

For a comprehensive list of configuration options check the [configuration reference](https://charmhub.io/discourse-k8s/configure).
For a comprehensive list of configuration options check the [configuration reference](https://charmhub.io/discourse-k8s/configure).
2 changes: 1 addition & 1 deletion docs/how-to/configure-s3.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ To enable S3 to perform backups, you'll need to specify also `s3_backup_bucket`.
It is also possible to configure the S3 bucket to act as a content delivery network (CDN) serving the static content directly from the bucket; for that, set `s3_cdn_url`. If you wish to modify the CORS set up, you can do so by changing `s3_install_cors_rule`.


For more details on the configuration options and their default values see the [configuration reference](https://charmhub.io/discourse-k8s/configure).
For more details on the configuration options and their default values see the [configuration reference](https://charmhub.io/discourse-k8s/configure).
2 changes: 1 addition & 1 deletion docs/how-to/configure-saml.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ juju config saml-integrator entity_id=https://login.staging.ubuntu.com
juju integrate discourse-k8s saml-integrator
```

For more details on the configuration options and their default values see the [configuration reference](https://charmhub.io/discourse-k8s/configure).
For more details on the configuration options and their default values see the [configuration reference](https://charmhub.io/discourse-k8s/configure).
2 changes: 1 addition & 1 deletion docs/how-to/contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,4 +100,4 @@ juju deploy ./discourse-k8s_ubuntu-20.04-amd64.charm \

## Canonical Contributor Agreement

Canonical welcomes contributions to the Discourse 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 Discourse Operator. Please check out our [contributor agreement](https://ubuntu.com/legal/contributors) if you're interested in contributing to the solution.
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ fixes and constructive feedback.
1. [Reference](reference)
1. [Actions](reference/actions.md)
1. [Configurations](reference/configurations.md)
1. [External Access](reference/external-access.md)
1. [Integrations](reference/integrations.md)
1. [Plugins](reference/plugins.md)
1. [External Access](reference/external-access.md)
1. [Explanation](explanation)
1. [Charm architecture](explanation/charm-architecture.md)
1. [Charm architecture](explanation/charm-architecture.md)
2 changes: 1 addition & 1 deletion docs/reference/actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

See [Actions](https://charmhub.io/discourse-k8s/actions).

> Read more about actions in the Juju docs: [Action](https://juju.is/docs/juju/action)
> Read more about actions in the Juju docs: [Action](https://juju.is/docs/juju/action)
2 changes: 1 addition & 1 deletion docs/reference/configurations.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

See [Configurations](https://charmhub.io/discourse-k8s/configure).

> Read more about configurations in the Juju docs: [Configuration](https://juju.is/docs/juju/configuration)
> Read more about configurations in the Juju docs: [Configuration](https://juju.is/docs/juju/configuration)
16 changes: 0 additions & 16 deletions docs/reference/external-access.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/reference/integrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,4 +80,4 @@ Discourse uses Redis to run background tasks (with Sidekiq) and keep the applica
Redis integrate commands:
```
juju integrate discourse-k8s redis-k8s
```
```
2 changes: 1 addition & 1 deletion docs/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,4 +151,4 @@ If you used Multipass, to remove the Multipass instance you created for this tut
```
multipass delete --purge my-juju-vm
```
Finally, remove the `127.0.0.1 discourse-k8s` line from the `/etc/hosts` file.
Finally, remove the `127.0.0.1 discourse-k8s` line from the `/etc/hosts` file.
Loading