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

chore(docs): Updated Index and Tutorial docs #456

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

alithethird
Copy link
Contributor

Applicable spec:

Overview

Standarise the Indico tutorial with other tutorials and improve/fix the tutorial.
Update the Indico index.md to standardise it with the other charms.

Rationale

Juju Events Changes

Module Changes

Library Changes

Checklist

@alithethird alithethird added the documentation Improvements or additions to documentation label Oct 3, 2024
@alithethird alithethird requested a review from a team as a code owner October 3, 2024 07:50
docs/tutorial.md Outdated Show resolved Hide resolved
docs/tutorial.md Outdated Show resolved Hide resolved
docs/tutorial.md Outdated Show resolved Hide resolved
docs/tutorial.md Outdated Show resolved Hide resolved
erinecon
erinecon previously approved these changes Oct 3, 2024
Copy link
Contributor

@erinecon erinecon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both pages look great -- thank you for working on them!

docs/tutorial.md Outdated Show resolved Hide resolved
yanksyoon
yanksyoon previously approved these changes Oct 3, 2024
Copy link
Contributor

@yanksyoon yanksyoon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor suggestions, LGTM thank you!

docs/tutorial.md Outdated Show resolved Hide resolved
docs/tutorial.md Outdated Show resolved Hide resolved
nrobinaubertin
nrobinaubertin previously approved these changes Oct 3, 2024
docs/tutorial.md Outdated Show resolved Hide resolved
Copy link
Contributor

@erinecon erinecon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor

github-actions bot commented Oct 4, 2024

Test coverage for 4f3f253

Name                       Stmts   Miss Branch BrPart  Cover   Missing
----------------------------------------------------------------------
src/charm.py                 349     12     86      8    95%   404, 418-419, 669, 710-711, 802->818, 804->813, 813->818, 826-827, 866, 899->exit, 937-943
src/database_observer.py      32      0      4      0   100%
src/s3_observer.py            17      0      0      0   100%
src/saml_observer.py          14      0      0      0   100%
src/smtp_observer.py          15      0      0      0   100%
src/state.py                  73      0     10      0   100%
----------------------------------------------------------------------
TOTAL                        500     12    100      8    97%

Static code analysis report

Run started:2024-10-04 13:38:49.645988

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 3113
  Total lines skipped (#nosec): 2
  Total potential issues skipped due to specifically being disabled (e.g., #nosec BXXX): 0

Run metrics:
  Total issues (by severity):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
  Total issues (by confidence):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
Files skipped (0):

Enable the ingress on MicroK8s first:

```bash
sudo microk8s enable ingress
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since it was mentioned as a requirement, do you think this step is needed?

- NGINX Ingress Controller. If you're using [MicroK8s](https://microk8s.io/), this can be done by running the command `microk8s enable ingress`. For more details, see [Addon: Ingress](https://microk8s.io/docs/addon-ingress).

For more information about how to install Juju, see [Get started with Juju](https://juju.is/docs/olm/get-started-with-juju).

### Shell into the Multipass VM

To be able to work inside the Multipass VM first you need to log in with the following command:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment here about Multipass VM not being mentioned as a requirement.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Libraries: Out of sync trivial
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants