canonical / canonical/operator

Improve the README, including updating the example charm

Open
#1,655 9 comments 0 reactions 0 assignees View on GitHub
docs rainy day
Dominant language
Python
Stars
267
Forks
136
Avg merge
1d 22h
Merged PRs (30d)
28

Description

The README (which also [displays on PyPI](https://pypi.org/project/ops/)) could be more approachable for people who want to quickly get the point of Ops and try out Ops.

Mainly, I think it would be great if the README had a tight, self-contained set of steps for making a simple charm and showing what the charm does when deployed & tested. We should be able to take advantage of Concierge and an improved Charmcraft profile (upcoming) to limit the number of steps.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.