Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

docs: change README #2

Merged
merged 5 commits into from
Sep 9, 2024
Merged

docs: change README #2

merged 5 commits into from
Sep 9, 2024

Conversation

amandahla
Copy link
Collaborator

@amandahla amandahla commented Sep 3, 2024

Applicable spec:

Overview

This PR changes README default file.

  • Add introduction
  • Add architecture diagram
  • Fix links

Rationale

Add README to the charm repo.

Juju Events Changes

Module Changes

Library Changes

Checklist

No charmhub available yet.

@amandahla amandahla requested a review from a team as a code owner September 3, 2024 19:01
@amandahla amandahla changed the title docs: Change README docs: change README Sep 3, 2024
@amandahla amandahla added the documentation Improvements or additions to documentation label Sep 3, 2024
README.md Show resolved Hide resolved
Copy link

github-actions bot commented Sep 9, 2024

Test coverage for 0cdc949

Name           Stmts   Miss Branch BrPart  Cover   Missing
----------------------------------------------------------
src/charm.py      26      5      0      0    81%   48-52
----------------------------------------------------------
TOTAL             26      5      0      0    81%

Static code analysis report

Run started:2024-09-09 14:22:51.285601

Test results:
  No issues identified.

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

README.md Show resolved Hide resolved
.trivyignore Show resolved Hide resolved
README.md Show resolved Hide resolved
@amandahla amandahla merged commit 310b16d into main Sep 9, 2024
17 checks passed
@amandahla amandahla deleted the ISD-2337-docs branch September 9, 2024 18:27
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants