cli: explain public to private changes

Add an example of changing a public repository to a private repository, noting that any replicated data will be public, but any new changes will not be replicated. Signed-off-by: Fintan Halpenny <[email protected]> X-Clacks-Overhead: GNU Terry Pratchett
radicle-dev · Apr 3, 2024 · ea69168 · ea69168
1 parent a71289f
commit ea69168
Showing 1 changed file with 42 additions and 0 deletions.
diff --git a/radicle-cli/examples/rad-publish.md b/radicle-cli/examples/rad-publish.md
@@ -17,3 +17,45 @@ $ rad publish
 ✗ Error: repository is already public
 ✗ Hint: to announce the repository to the network, run `rad sync --inventory`
 ```
+
+We can also make the repository private again by using `rad id
+update`. However, it's important to note that once the repository is
+published to the network, that set of data will be public until all
+node operators delete it. Any new changes made after making the
+repository private again __will not_ be replicated.
+
+```
+$ rad id update --visibility private --title "Privatise" --description "Reverting the rad publish event"
+✓ Identity revision 774cc1e72641d97d7dc9377745b7f454a9171747 created
+╭───────────────────────────────────────────────────────────────────╮
+│ Title    Privatise                                                │
+│ Revision 774cc1e72641d97d7dc9377745b7f454a9171747                 │
+│ Blob     88f759a4d46e9535766fccec0cbfe1fed6160b1a                 │
+│ Author   did:key:z6MknSLrJoTcukLrE435hVNQT4JUhbvWLX4kUzqkEStBU8Vi │
+│ State    accepted                                                 │
+│ Quorum   yes                                                      │
+│                                                                   │
+│ Reverting the rad publish event                                   │
+├───────────────────────────────────────────────────────────────────┤
+│ ✓ did:key:z6MknSLrJoTcukLrE435hVNQT4JUhbvWLX4kUzqkEStBU8Vi  (you) │
+╰───────────────────────────────────────────────────────────────────╯
+
+@@ -1,13 +1,16 @@
+ {
+   "payload": {
+     "xyz.radicle.project": {
+       "defaultBranch": "master",
+       "description": "radicle heartwood protocol & stack",
+       "name": "heartwood"
+     }
+   },
+   "delegates": [
+     "did:key:z6MknSLrJoTcukLrE435hVNQT4JUhbvWLX4kUzqkEStBU8Vi"
+   ],
+-  "threshold": 1
++  "threshold": 1,
++  "visibility": {
++    "type": "private"
++  }
+ }
+```