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

Initial README, with sections commented out that aren't yet true #3

Merged
merged 18 commits into from
Jun 27, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 39 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,48 @@
<!--
Avoid using this README file for information that is maintained or published elsewhere, e.g.:

* metadata.yaml > published on Charmhub
* documentation > published on (or linked to from) Charmhub
* detailed contribution guide > documentation or CONTRIBUTING.md

Use links instead.
[![CharmHub Badge](https://charmhub.io/penpot/badge.svg)](https://charmhub.io/penpot)
[![Publish to edge](https://github.com/canonical/penpot-operator/actions/workflows/publish_charm.yaml/badge.svg)](https://github.com/canonical/penpot-operator/actions/workflows/publish_charm.yaml)
[![Promote charm](https://github.com/canonical/penpot-operator/actions/workflows/promote_charm.yaml/badge.svg)](https://github.com/canonical/penpot-operator/actions/workflows/promote_charm.yaml)
[![Discourse Status](https://img.shields.io/discourse/status?server=https%3A%2F%2Fdiscourse.charmhub.io&style=flat&label=CharmHub%20Discourse)](https://discourse.charmhub.io)
-->

# is-charms-template

Charmhub package name: operator-template
More information: https://charmhub.io/is-charms-template
A Juju charm that deploys and manages [Penpot](https://penpot.app) on Kubernetes. Penpot is the
web-based open-source design tool that bridges the gap between designers and
developers.

Describe your charm in one or two sentences.
<!--
This charm simplifies initial deployment and "day N" operations of Penpot,
such as scaling the number of instances, integration with external
authentication providers, access to S3 for redundant file storage and more. It
allows for deployment on many different Kubernetes platforms, from [MicroK8s](https://microk8s.io) to
[Charmed Kubernetes](https://ubuntu.com/kubernetes) to public cloud Kubernetes
offerings.
-->

## Other resources
As such, the charm makes it easy for those looking to take control of their
own Penpot deployment while keeping operations simple, and gives them the
freedom to deploy on the Kubernetes platform of their choice.

<!-- If your charm is documented somewhere else other than Charmhub, provide a link separately. -->
<!--
For DevOps or SRE teams this charm will make operating Penpot simple and
straightforward through Juju's clean interface. It will allow easy deployment
into multiple environments for testing of changes, and supports scaling out for
enterprise deployments.
-->

- [Read more](https://example.com)
## Project and community

- [Contributing](CONTRIBUTING.md) <!-- or link to other contribution documentation -->
The Penpot Operator is a member of the Ubuntu family. It's an
open source project that warmly welcomes community projects, contributions,
suggestions, fixes and constructive feedback.
* [Code of conduct](https://ubuntu.com/community/code-of-conduct)
* [Get support](https://discourse.charmhub.io/)
<!--
* [Contribute](https://charmhub.io/penpot/docs/contributing)
* [Roadmap](https://charmhub.io/penpot/docs/roadmap)
-->
Thinking about using Penpot for your next project? [Get in touch](https://chat.charmhub.io/charmhub/channels/charm-dev)!

- See the [Juju SDK documentation](https://juju.is/docs/sdk) for more information about developing and improving charms.
---
<!--
For further details, [see the charm's detailed documentation](https://charmhub.io/penpot/docs).
-->
Loading