Merge ~alnvdl/charm-ubuntu-advantage:rename-pro into charm-ubuntu-advantage:master

Proposed by Allan Vidal
Status: Merged
Approved by: Allan Vidal
Approved revision: 33715cf73861b4eae84243bf2ee3036c10fc156c
Merged at revision: 48b4cd66248046898e30edb4ff429aba1d2fe6b5
Proposed branch: ~alnvdl/charm-ubuntu-advantage:rename-pro
Merge into: charm-ubuntu-advantage:master
Diff against target: 87 lines (+28/-9)
4 files modified
README.md (+23/-4)
config.yaml (+3/-3)
metadata.yaml (+1/-1)
src/charm.py (+1/-1)
Reviewer Review Type Date Requested Status
Andrew Polukhin Approve
Kian Parvin Approve
Review via email: mp+454655@code.launchpad.net

Commit message

Update documentation

To post a comment you must log in.
Revision history for this message
🤖 Canonical IS Merge Bot (canonical-is-mergebot) wrote :

This merge proposal is being monitored by mergebot. Change the status to Approved to merge.

Revision history for this message
Kian Parvin (kian-parvin) :
review: Approve
Revision history for this message
Andrew Polukhin (andrew-polukhin) wrote :

Thanks!

review: Approve
Revision history for this message
🤖 Canonical IS Merge Bot (canonical-is-mergebot) wrote :

Change successfully merged at revision 48b4cd66248046898e30edb4ff429aba1d2fe6b5

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1diff --git a/README.md b/README.md
2index 6884762..e9bd371 100644
3--- a/README.md
4+++ b/README.md
5@@ -1,13 +1,32 @@
6-# Ubuntu Advantage charm
7+# charm-ubuntu-advantage
8
9-## Description
10+This charm enables Ubuntu Pro (https://ubuntu.com/pro) subscriptions.
11
12-This charm enables Ubuntu Advantage (https://ubuntu.com/advantage) subscriptions.
13+Despite the rename of Ubuntu Advantage to Ubuntu Pro, the "ubuntu-advantage"
14+name remains to avoid breaking existing deployments of this charm.
15+
16+This charm is maintained by the Ubuntu Pro team within Commercial Systems at
17+Canonical.
18
19 ## Usage
20
21-Be sure to replace `<token>` with a valid value from [the Ubuntu Advantage website](https://ubuntu.com/advantage).
22+Be sure to replace `<token>` with a valid value from
23+[the Ubuntu Pro website](https://ubuntu.com/pro):
24
25 juju deploy ubuntu
26 juju deploy ubuntu-advantage --config token=<token>
27 juju add-relation ubuntu ubuntu-advantage
28+
29+## Development
30+
31+This charm is developed at https://code.launchpad.net/charm-ubuntu-advantage.
32+
33+It is released to the `edge` channel via a recipe:
34+https://launchpad.net/~ubuntu-advantage-charmers/charm-ubuntu-advantage/+charm/ubuntu-advantage.
35+
36+It is currently published at https://charmhub.io/ubuntu-advantage, but it is
37+not promulgated.
38+
39+In the past, it was also published as https://charmhub.io/ubuntu-pro (also
40+not promulgated), but that was discontinued until proper support for charm
41+renames is introduced.
42diff --git a/config.yaml b/config.yaml
43index 1f7a3d4..a6fb1a7 100644
44--- a/config.yaml
45+++ b/config.yaml
46@@ -6,13 +6,13 @@
47 options:
48 contract_url:
49 default: "https://contracts.canonical.com"
50- description: Contract service URL to use
51+ description: URL of the Ubuntu Pro contracts service backend to use.
52 type: string
53 ppa:
54 default: ""
55- description: PPA from which to install the ubuntu-advantage-tools package
56+ description: PPA from which to install the ubuntu-advantage-tools package.
57 type: string
58 token:
59 default: ""
60- description: Ubuntu Advantage subscription token obtained from https://ubuntu.com/advantage
61+ description: Ubuntu Pro token obtained from https://ubuntu.com/pro.
62 type: string
63diff --git a/metadata.yaml b/metadata.yaml
64index 64dbf7d..9f380b1 100644
65--- a/metadata.yaml
66+++ b/metadata.yaml
67@@ -1,6 +1,6 @@
68 name: ubuntu-advantage
69 description: Ubuntu Advantage charm
70-summary: This charm enables Ubuntu Advantage (https://ubuntu.com/advantage) subscriptions
71+summary: This charm enables Ubuntu Pro (https://ubuntu.com/pro) subscriptions.
72 series:
73 - focal
74 - bionic
75diff --git a/src/charm.py b/src/charm.py
76index 3031f9b..04bd738 100755
77--- a/src/charm.py
78+++ b/src/charm.py
79@@ -2,7 +2,7 @@
80 # Copyright 2021 Canonical Ltd.
81 # See LICENSE file for licensing details.
82
83-"""Charmed Operator to enable Ubuntu Advantage (https://ubuntu.com/advantage) subscriptions."""
84+"""Charmed Operator to enable Ubuntu Pro (https://ubuntu.com/pro) subscriptions."""
85
86 import hashlib
87 import json

Subscribers

People subscribed via source and target branches