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.

Sign up for GitHub

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

Jump to bottom

update README according to template (ISD-2745) #1897

Merged
merged 8 commits into from
Dec 18, 2024
Merged

update README according to template (ISD-2745) #1897

merged 8 commits into from
Dec 18, 2024

Conversation

erinecon
Copy link
Contributor

Overview

Update the README according to the template README.

Rationale

  • Update the introduction text to align with the template
  • Add a "Get started" section, pointing to the Charmhub documentation
  • Add links to the Charmhub documentation for actions, integrations, and configurations
  • Place previous text in README under "Basic operations"
  • Add "Learn more" and "Project and community" sections

Module Changes

None

Checklist

  • The contributing guide was applied
  • The documentation is generated using src-docs
  • The PR is tagged with appropriate label (urgent, trivial, complex)
  • Version has been incremented on pyproject.toml and rockcraft.yaml

@erinecon erinecon added documentation Improvements or additions to documentation trivial labels Dec 17, 2024
@erinecon erinecon marked this pull request as ready for review December 18, 2024 13:32
@erinecon erinecon requested a review from a team as a code owner December 18, 2024 13:32
@cbartz cbartz self-requested a review December 18, 2024 13:35
@cbartz cbartz requested a review from jdkandersson December 18, 2024 13:35
cbartz
cbartz reviewed Dec 18, 2024
View reviewed changes
Copy link
Collaborator

@cbartz cbartz 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! It looks good. I just have one suggestion, to give a bit of rationale at the beginning.

README.md Show resolved Hide resolved
@erinecon erinecon merged commit 2d936b7 into main Dec 18, 2024
9 checks passed
@erinecon erinecon deleted the update-readme branch December 18, 2024 15:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jdkandersson jdkandersson jdkandersson approved these changes

@cbartz cbartz cbartz approved these changes

Assignees

@cbartz cbartz

Labels
documentation Improvements or additions to documentation trivial
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@erinecon @cbartz @jdkandersson