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: Removes documentation from README and link to docs on Charmhub instead #56

Merged
merged 1 commit into from
Feb 26, 2024

Conversation

saltiyazan
Copy link
Contributor

Description

  • Improves the README file and the metadata.yaml file
  • Improves the explanation of the config options in the config file

Note for reviewers:
Please take a look at the enhanced docs in Charmhub:

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • I have added tests that validate the behaviour of the software
  • I validated that new and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have bumped the version of the library

Improves the README file and the metadata.yaml file
Improves the explanation of the config options in the config file
@saltiyazan saltiyazan requested a review from a team as a code owner February 23, 2024 09:05
## Relations

- `certificates`: `tls-certificates-interface` provider
For more information including guides, integrations, configuration options, see [HTTP Request LEGO's Charmhub page](https://charmhub.io/httprequest-lego-k8s).
Copy link
Contributor

Choose a reason for hiding this comment

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

Nice, that's much better than people using this github page :)

@saltiyazan saltiyazan merged commit 211d902 into main Feb 26, 2024
8 checks passed
@saltiyazan saltiyazan deleted the TLSENG-118-improves-documentation branch February 26, 2024 09:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants