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

Initial documentation #51

Merged
merged 22 commits into from
Dec 10, 2024
Merged

Initial documentation #51

merged 22 commits into from
Dec 10, 2024

Conversation

arturo-seijas
Copy link
Collaborator

@arturo-seijas arturo-seijas commented Dec 3, 2024

Applicable spec:

Overview

Rationale

Juju Events Changes

Module Changes

Library Changes

Checklist

@arturo-seijas arturo-seijas added the documentation Improvements or additions to documentation label Dec 3, 2024
@arturo-seijas arturo-seijas requested a review from a team as a code owner December 3, 2024 09:30
README.md Outdated Show resolved Hide resolved
docs/how-to/contribute.md Outdated Show resolved Hide resolved
docs/how-to/contribute.md Outdated Show resolved Hide resolved
docs/how-to/contribute.md Outdated Show resolved Hide resolved
docs/how-to/contribute.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link

@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.

Thank you for adding all these docs!

docs/explanation/charm-architecture.md Outdated Show resolved Hide resolved
docs/explanation/charm-architecture.md Outdated Show resolved Hide resolved
docs/explanation/charm-architecture.md Outdated Show resolved Hide resolved
docs/explanation/charm-architecture.md Outdated Show resolved Hide resolved
docs/explanation/charm-architecture.md Show resolved Hide resolved
docs/tutorial/getting-started.md Outdated Show resolved Hide resolved
docs/tutorial/getting-started.md Outdated Show resolved Hide resolved
docs/tutorial/getting-started.md Show resolved Hide resolved
docs/tutorial/getting-started.md Show resolved Hide resolved
docs/tutorial/getting-started.md Show resolved Hide resolved
Copy link

@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.

Thanks for adding the docs! I approve of the changes 👍
(Not giving an official approval since there are code changes in this PR.)
(The code changes are doc-related)

Copy link

Test coverage for 5461020

Name                            Stmts   Miss Branch BrPart  Cover   Missing
---------------------------------------------------------------------------
src/certificates_observer.py       59      0      0      0   100%
src/charm.py                       93     19     24      6    74%   62-69, 107, 140-145, 156, 158, 160, 209-217
src/opensearch_observer.py         12      0      0      0   100%
src/state.py                      128     17     14      2    87%   89-90, 135-136, 163-164, 184-185, 188, 207, 209-211, 336-341
src/traefik_route_observer.py      39      0      6      0   100%
src/wazuh.py                      157     43     22      2    73%   101, 197-198, 211-217, 262->exit, 284-307, 318-330, 381-418
---------------------------------------------------------------------------
TOTAL                             488     79     66     10    82%

Static code analysis report

Run started:2024-12-10 14:46:56.942320

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 2492
  Total lines skipped (#nosec): 12
  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):

@arturo-seijas arturo-seijas merged commit beeec73 into main Dec 10, 2024
16 of 17 checks passed
@arturo-seijas arturo-seijas deleted the docs branch December 10, 2024 15:02
Copy link

@Thanhphan1147 Thanhphan1147 left a comment

Choose a reason for hiding this comment

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

LGTM!

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants