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

Add readme and some docs #8

Merged
merged 11 commits into from
Jan 10, 2025
Merged

Add readme and some docs #8

merged 11 commits into from
Jan 10, 2025

Conversation

arturo-seijas
Copy link
Collaborator

@arturo-seijas arturo-seijas commented Jan 8, 2025

Applicable spec:

Overview

Add readme, how to contribute and external access docs

Rationale

Juju Events Changes

Module Changes

Library Changes

Checklist

@arturo-seijas arturo-seijas added the documentation Improvements or additions to documentation label Jan 8, 2025
@arturo-seijas arturo-seijas requested a review from erinecon January 8, 2025 13:44
@arturo-seijas arturo-seijas requested a review from a team as a code owner January 8, 2025 13:44
README.md Outdated Show resolved Hide resolved
README.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.

Thanks for adding documentation for this charm!

One question I am wondering about is whether it's worth adding an index.md page for Charmhub into this PR. I don't know how much extra work or effort that will be for you.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/how-to/contribute.md Show resolved Hide resolved
docs/how-to/contribute.md Outdated Show resolved Hide resolved
@arturo-seijas arturo-seijas requested a review from erinecon January 9, 2025 16:43
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 the updates! A couple more comments and then should be good to go :)

docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link

Test coverage for 0b93f29

Name                     Stmts   Miss Branch BrPart  Cover   Missing
--------------------------------------------------------------------
reactive/smtp_relay.py     285      0     90      0   100%
--------------------------------------------------------------------
TOTAL                      285      0     90      0   100%

Static code analysis report

Run started:2025-01-10 08:14:33.582176

Test results:
  No issues identified.

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

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 contributing to the docs!

@arturo-seijas arturo-seijas merged commit 6c88cc5 into main Jan 10, 2025
15 of 17 checks passed
@arturo-seijas arturo-seijas deleted the update-readme branch January 10, 2025 15:07
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: OK
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants