Skip to content

Commit 8e5fde7

Browse files
tmihoclengau
authored andcommitted
docs: update readme to drop old links
1 parent e16a238 commit 8e5fde7

File tree

1 file changed

+8
-33
lines changed

1 file changed

+8
-33
lines changed

README.md

Lines changed: 8 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -5,24 +5,15 @@
55

66
# Charmcraft -- easily initialise, pack, and publish your charms
77

8-
Charmcraft is a CLI tool that makes it easy and quick to initialise, package, and publish Kubernetes and machine charms. It is an official component of the Charm SDK, itself a part of [the Juju universe](https://juju.is/).
9-
10-
||||
11-
|-|-|- |
12-
|| [Juju](https://juju.is/docs/juju) | Learn how to quickly deploy, integrate, and manage charms on any cloud with Juju. <br> _It's as simple as `juju deploy foo`, `juju integrate foo bar`, ..., on any cloud._ |
13-
||||
14-
|| [Charmhub](https://charmhub.io/) | Sample our existing charms on Charmhub. <br> _A charm can be a cluster ([OpenStack](https://charmhub.io/openstack-base), [Kubernetes](https://charmhub.io/charmed-kubernetes)), a data platform ([PostgreSQL](https://charmhub.io/postgresql-k8s), [MongoDB](https://charmhub.io/mongodb), etc.), an observability stack ([Canonical Observability Stack](https://charmhub.io/cos-lite)), an MLOps solution ([Kubeflow](https://charmhub.io/kubeflow)), and so much more._ |
15-
||||
16-
|:point_right:| [Charm SDK](https://juju.is/docs/sdk) | Write your own charm! <br> _Juju is written in Go, but our SDK supports easy charm development in Python._ |
17-
8+
Charmcraft is a CLI tool that makes it easy and quick to initialise, package, and publish Kubernetes and machine charms.
189

1910
## Give it a try
2011

2112
Let's use Charmcraft to initialise and pack a Kubernetes charm:
2213

2314
### Set up
2415

25-
> See [Charm SDK | Set up your development environment automatically > Set up an Ubuntu `charm-dev` VM with Multipass](https://juju.is/docs/sdk/dev-setup#heading--automatic-set-up-an-ubuntu-charm-dev-vm-with-multipass). <br> Choose the MicroK8s track.
16+
> See [Juju | Set things up](https://canonical-juju.readthedocs-hosted.com/en/latest/user/howto/manage-your-deployment/manage-your-deployment-environment/#set-things-up). <br> Choose the automatic track and MicroK8s.
2617
2718
### Initialise and pack your charm
2819

@@ -55,13 +46,13 @@ test_charm.py
5546
test_charm.py
5647
```
5748

58-
Poke around:
49+
Poke around:
5950

6051
Note that the `charmcraft.yaml` file shows that what we have is an example charm called `my-new-charm`, which builds on Ubuntu 22.04 and which uses an OCI image resource `httpbin` from `kennethreitz/httpbin`.
6152

6253
Note that the `src/charm.py` file contains code scaffolding featuring the Charm SDK's Ops library for writing charms.
6354

64-
Explore further, start editing the files, or skip ahead and pack the charm:
55+
Explore further, start editing the files, or skip ahead and pack the charm:
6556

6657
```
6758
charmcraft pack
@@ -79,26 +70,10 @@ But Charmcraft goes far beyond `init` and `pack`. For example, when you're ready
7970

8071
### Clean up
8172

82-
> See [Charm SDK | Set up your development environment automatically > Clean up](https://juju.is/docs/sdk/dev-setup#heading--automatic-set-up-an-ubuntu-charm-dev-vm-with-multipass).
73+
> See [Juju | Tear things down](https://canonical-juju.readthedocs-hosted.com/en/latest/user/howto/manage-your-deployment/manage-your-deployment-environment/#tear-things-down). <br> Choose the automatic track.
8374
8475
## Next steps
8576

86-
### Learn more
87-
88-
Read our [user documentation](https://juju.is/docs/sdk/charmcraft), which also includes other guides showing Charmcraft in action
89-
90-
### Chat with us
91-
92-
Read our [Code of conduct](https://ubuntu.com/community/code-of-conduct) and:
93-
- Join our chat: [Matrix](https://matrix.to/#/#charmhub-charmcraft:ubuntu.com)
94-
- Join our forum: [Discourse](https://discourse.charmhub.io/)
95-
96-
### File an issue
97-
98-
- Report a Charmcraft bug on [GitHub](https://github.com/canonical/charmcraft/issues)
99-
- Raise a general https://juju.is/docs documentation issue on [GitHub | juju/docs](https://github.com/juju/docs)
100-
101-
### Make your mark
102-
103-
- Read our [documentation contributor guidelines](https://discourse.charmhub.io/t/documentation-guidelines-for-contributors/1245) and help improve a doc
104-
- Read our [codebase contributor guidelines](https://github.com/canonical/charmcraft/blob/main/CONTRIBUTING.md) and help improve the codebase
77+
- Read the [docs](https://canonical-charmcraft.readthedocs-hosted.com/en/stable/).
78+
- Read our [Code of conduct](https://ubuntu.com/community/code-of-conduct) and join our [chat](https://matrix.to/#/#charmhub-charmcraft:ubuntu.com) and [forum](https://discourse.charmhub.io/) or [open an issue](https://github.com/canonical/charmcraft/issues).
79+
- Read our [CONTRIBUTING guide](https://github.com/canonical/charmcraft/blob/main/CONTRIBUTING.md) and contribute!

0 commit comments

Comments
 (0)