Skip to content

Commit

Permalink
Docs(README): Updated README (#460)
Browse files Browse the repository at this point in the history
* Docs(README): Updated README

* Docs(README): Fixed Issues link

* Chore(): Applied Erin's comments and pinned websockets version

* Chore(docs): Update index.md according to Discourse post

* chore(docs): Add `Troubleshooting` with matrix link

* Chore(docs): update navigation table

* chore(docs): Try to make gatekeeper work

* Chore(): Updated Nginx rock to Noble.

* Chore(): Update golang ver

* Chore(): Update golang in nginx rock

* Chore(): Changed `nginx-prometheus-exporter` from snap to source

* Chore(): Ignore pebble in trivy scan

* Chore(): Revert the changes
  • Loading branch information
alithethird authored Nov 22, 2024
1 parent 4a506e2 commit 36d6e47
Show file tree
Hide file tree
Showing 2 changed files with 60 additions and 44 deletions.
60 changes: 36 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,36 +6,48 @@
# Indico Operator

A Juju charm deploying and managing Indico on Kubernetes. Indico is an
open-source tool for event organisation, archival and collaboration.

This charm simplifies initial deployment and "day N" operations of Indico
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
open-source tool for event organisation, archival and collaboration. 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
events management system whilst keeping operations simple, and gives them the
freedom to deploy on the Kubernetes platform of their choice.
Like any Juju charm, this charm supports one-line deployment, configuration, integration, scaling, and more. For Charmed Indico, this includes:
- Scaling
- Integration with SSO
- Integration with S3 for redundant file storage

For DevOps or SRE teams this charm will make operating Indico simple and
straightforward through Juju's clean interface. It will allow easy deployment
into multiple environments for testing of changes, and supports scaling out for
enterprise deployments.
For information about how to deploy, integrate, and manage this charm, see the Official [Indico Operator Documentation](https://charmhub.io/indico/docs).

## Project and community

The Indico 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.
* [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/indico/docs/how-to-contribute)
Thinking about using the Indico Operator for your next project? [Get in touch](https://chat.charmhub.io/charmhub/channels/charm-dev)!
## Get started

You can follow the tutorial [here](https://charmhub.io/indico/docs/getting-started).

### Basic operations

The following actions are available for this charm:
- refresh-external-resources: refresh the external resources (e.g. S3 bucket)
- add-admmin: add an admin user
- anonymize-user: anonymize a user

---
You can check out the [full list of actions here](https://charmhub.io/indico/actions).

For further details,
[see the charm's detailed documentation](https://charmhub.io/indico/docs).
## Integrations

This charm can be integrated with other Juju charms and services:

- [Redis](https://charmhub.io/redis-k8s): Redis is an open source (BSD licensed), in-memory data structure store, used as a database, cache and message broker.
- [S3](https://charmhub.io/s3-integrator): Amazon Simple Storage Service (Amazon S3) is an object storage service that provides secure, durable, highly available storage with massive scalability and low latency.
- [Postgresql](https://charmhub.io/postgresql-k8s): PostgreSQL is a powerful, open source object-relational database system. It has more than 15 years of active development and a proven architecture that has earned it a strong reputation for reliability, data integrity, and correctness.

and much more. You can find the full list of integrations [here](https://charmhub.io/indico/integrations).

## Learn more
* [Read more](https://charmhub.io/indico) <!--Link to the charm's official documentation-->
* [Developer documentation](https://docs.getindico.io/en/stable/) <!--Link to any developer documentation-->
* [Official webpage](https://indico.cern.ch/) <!--(Optional) Link to official webpage/blog/marketing content-->
* [Troubleshooting](https://matrix.to/#/#charmhub-charmdev:ubuntu.com) <!--(Optional) Link to a page or section about troubleshooting/FAQ-->
## Project and community
* [Issues](https://github.com/canonical/indico-operator/issues) <!--Link to GitHub issues (if applicable)-->
* [Contributing](https://charmhub.io/indico/docs/how-to-contribute) <!--Link to any contribution guides-->
* [Matrix](https://matrix.to/#/#charmhub-charmdev:ubuntu.com) <!--Link to contact info (if applicable), e.g. Matrix channel-->
44 changes: 24 additions & 20 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,23 +36,27 @@ The Indico Operator is a member of the Ubuntu family. It's an open-source projec

Thinking about using the Indico Operator for your next project? [Get in touch](https://matrix.to/#/#charmhub-charmdev:ubuntu.com)!

# Contents

1. [Tutorial](tutorial.md)
1. [How to](how-to)
1. [Configure a proxy](how-to/configure-a-proxy.md)
1. [Configure S3](how-to/configure-s3.md)
1. [Configure SAML](how-to/configure-saml.md)
1. [Configure SMTP](how-to/configure-smtp.md)
1. [Configure the external hostname](how-to/configure-the-external-hostname.md)
1. [Contribute](how-to/contribute.md)
1. [Customize theme](how-to/customize-theme.md)
1. [Install plugins](how-to/install-plugins.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. [Theme customization](reference/theme-customization.md)
1. [Explanation](explanation)
1. [Charm architecture](explanation/charm-architecture.md)
# Navigation

| Level | Path | Navlink |
| --- | --- | --- |
| 1 | tutorial | [Tutorial](/t/indico-docs-quick-guide/8676) |
| 1 | how-to | [How to]() |
| 2 | how-to-configure-a-proxy | [Configure a proxy](/t/indico-docs-how-to-configure-a-proxy/8678) |
| 2 | how-to-configure-s3 | [Configure S3](/t/indico-docs-how-to-configure-s3/8680) |
| 2 | how-to-configure-saml | [Configure SAML](/t/indico-docs-how-to-configure-saml/8664) |
| 2 | how-to-configure-smtp | [Configure SMTP](/t/indico-docs-how-to-configure-smtp/8666) |
| 2 | how-to-configure-the-external-hostname | [Configure the external hostname](/t/indico-docs-how-to-configure-the-external-hostname/8660) |
| 2 | how-to-contribute | [Contribute](/t/indico-docs-how-to-contribute/7561) |
| 2 | how-to-customize-theme | [Customize theme](/t/indico-docs-how-to-customize-theme/8682) |
| 2 | how-to-install-plugins | [Install plugins](/t/indico-docs-how-to-install-plugins/8662) |
| 2 | how-to-redeploy | [How to redeploy](/t/indico-docs-how-to-redeploy-indico/15928) |
| 1 | reference | [Reference]() |
| 2 | reference-actions | [Actions](/t/indico-docs-actions/8668) |
| 2 | reference-configurations | [Configurations](/t/indico-docs-configurations/8670) |
| 2 | reference-external-access | [External access](/t/indico-docs-external-access/15929) |
| 2 | reference-integrations | [Integrations](/t/indico-docs-integrations/8672) |
| 2 | reference-plugins | [Plugins](/t/indico-docs-plugins/7567) |
| 2 | reference-theme-customization | [Theme customization](/t/indico-docs-theme-customization/8674) |
| 1 | explanation | [Explanation]() |
| 2 | explanation-charm-architecture | [Charm architecture](/t/indico-docs-charm-architecture/7559) |

0 comments on commit 36d6e47

Please sign in to comment.