From 7feb3e3b10e362331b9347b408cf4eaec73490f5 Mon Sep 17 00:00:00 2001 From: cloudhead Date: Fri, 19 Jan 2024 17:06:02 +0100 Subject: [PATCH] Use "repository" consistently over "project" We were using the two pretty interchangeably. "Project" should only be used to refer to the repository payload. "Repository" should be used when referring to the resource that is fetched, synced, cloned, checked out etc. --- rad.1.adoc | 2 +- radicle-cli/examples/rad-auth.md | 4 +- radicle-cli/examples/rad-clone-all.md | 2 +- radicle-cli/examples/rad-clone-connect.md | 2 +- radicle-cli/examples/rad-clone-directory.md | 2 +- radicle-cli/examples/rad-clone.md | 2 +- radicle-cli/examples/rad-fork.md | 2 +- radicle-cli/examples/rad-id-collaboration.md | 4 +- .../examples/rad-init-private-clone-seed.md | 2 +- radicle-cli/examples/rad-init-private.md | 6 +-- .../examples/rad-init-sync-not-connected.md | 10 ++--- .../examples/rad-init-sync-preferred.md | 12 +++--- radicle-cli/examples/rad-init-sync-timeout.md | 12 +++--- radicle-cli/examples/rad-init-sync.md | 14 +++---- .../examples/rad-init-with-existing-remote.md | 8 ++-- radicle-cli/examples/rad-init.md | 10 ++--- radicle-cli/examples/rad-patch-pull-update.md | 16 ++++---- radicle-cli/src/commands/auth.rs | 4 +- radicle-cli/src/commands/checkout.rs | 8 ++-- radicle-cli/src/commands/clean.rs | 2 +- radicle-cli/src/commands/clone.rs | 8 ++-- radicle-cli/src/commands/fork.rs | 6 +-- radicle-cli/src/commands/init.rs | 38 +++++++++---------- radicle-cli/src/commands/inspect.rs | 4 +- radicle-cli/src/commands/ls.rs | 2 +- radicle-cli/src/commands/patch.rs | 2 +- radicle-cli/src/commands/patch/review.rs | 2 +- radicle-cli/src/commands/publish.rs | 2 +- radicle-cli/src/commands/remote.rs | 4 +- radicle-cli/src/commands/sync.rs | 2 +- radicle-cli/src/commands/watch.rs | 2 +- radicle/src/rad.rs | 6 +-- 32 files changed, 102 insertions(+), 100 deletions(-) diff --git a/rad.1.adoc b/rad.1.adoc index 5ade0d85c..651ba84c5 100644 --- a/rad.1.adoc +++ b/rad.1.adoc @@ -164,7 +164,7 @@ a working copy and run the *rad init* command: $ cd my-repo $ rad init -You will be prompted to enter a project name and default branch. Once the +You will be prompted to enter a repository name and default branch. Once the repository is created, the Repository Identifier (RID) will be printed. Share this with collaborators so that they can clone your repository. diff --git a/radicle-cli/examples/rad-auth.md b/radicle-cli/examples/rad-auth.md index 826a7fc2e..f3822b874 100644 --- a/radicle-cli/examples/rad-auth.md +++ b/radicle-cli/examples/rad-auth.md @@ -10,8 +10,8 @@ Initializing your radicle ๐Ÿ‘พ identity โœ“ Your Radicle DID is did:key:z6MknSLrJoTcukLrE435hVNQT4JUhbvWLX4kUzqkEStBU8Vi. This identifies your device. Run `rad self` to show it at all times. โœ“ You're all set. -To create a radicle project, run `rad init` from a Git repository with at least one commit. -To clone a project, run `rad clone `. For example, `rad clone rad:z3gqcJUoA1n9HaHKufZs5FCSGazv5` clones the Radicle 'heartwood' project. +To create a Radicle repository, run `rad init` from a Git repository with at least one commit. +To clone a repository, run `rad clone `. For example, `rad clone rad:z3gqcJUoA1n9HaHKufZs5FCSGazv5` clones the Radicle 'heartwood' repository. To get a list of all commands, run `rad help`. ``` diff --git a/radicle-cli/examples/rad-clone-all.md b/radicle-cli/examples/rad-clone-all.md index f6ee9b61b..8fa5c7381 100644 --- a/radicle-cli/examples/rad-clone-all.md +++ b/radicle-cli/examples/rad-clone-all.md @@ -11,7 +11,7 @@ $ rad clone rad:z42hL2jL4XNk6K8oHQaSWfMgCL7ji --scope all โ”‚ Radicle Heartwood Protocol & Stack โ”‚ โ”‚ 0 issues ยท 0 patches โ”‚ โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ -Run `cd ./heartwood` to go to the project directory. +Run `cd ./heartwood` to go to the repository directory. ``` We can now have a look at the new working copy that was created from the cloned diff --git a/radicle-cli/examples/rad-clone-connect.md b/radicle-cli/examples/rad-clone-connect.md index 3b716561b..d453de5cb 100644 --- a/radicle-cli/examples/rad-clone-connect.md +++ b/radicle-cli/examples/rad-clone-connect.md @@ -17,5 +17,5 @@ $ rad clone rad:z42hL2jL4XNk6K8oHQaSWfMgCL7ji โ”‚ Radicle Heartwood Protocol & Stack โ”‚ โ”‚ 0 issues ยท 0 patches โ”‚ โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ -Run `cd ./heartwood` to go to the project directory. +Run `cd ./heartwood` to go to the repository directory. ``` diff --git a/radicle-cli/examples/rad-clone-directory.md b/radicle-cli/examples/rad-clone-directory.md index 2202feecd..02f48cb24 100644 --- a/radicle-cli/examples/rad-clone-directory.md +++ b/radicle-cli/examples/rad-clone-directory.md @@ -14,7 +14,7 @@ $ rad clone rad:z42hL2jL4XNk6K8oHQaSWfMgCL7ji --scope followed Developer/Radicle โ”‚ Radicle Heartwood Protocol & Stack โ”‚ โ”‚ 0 issues ยท 0 patches โ”‚ โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ -Run `cd [..]/Developer/Radicle` to go to the project directory. +Run `cd [..]/Developer/Radicle` to go to the repository directory. ``` Note that attempting to clone into a directory that already exists, diff --git a/radicle-cli/examples/rad-clone.md b/radicle-cli/examples/rad-clone.md index 48c547a58..e25d062e3 100644 --- a/radicle-cli/examples/rad-clone.md +++ b/radicle-cli/examples/rad-clone.md @@ -14,7 +14,7 @@ $ rad clone rad:z42hL2jL4XNk6K8oHQaSWfMgCL7ji --scope followed โ”‚ Radicle Heartwood Protocol & Stack โ”‚ โ”‚ 0 issues ยท 0 patches โ”‚ โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ -Run `cd ./heartwood` to go to the project directory. +Run `cd ./heartwood` to go to the repository directory. ``` We can now have a look at the new working copy that was created from the cloned diff --git a/radicle-cli/examples/rad-fork.md b/radicle-cli/examples/rad-fork.md index 3c64b1a52..bfedf69fc 100644 --- a/radicle-cli/examples/rad-fork.md +++ b/radicle-cli/examples/rad-fork.md @@ -22,7 +22,7 @@ wish to fork: ``` $ rad fork rad:z42hL2jL4XNk6K8oHQaSWfMgCL7ji -โœ“ Forked project rad:z42hL2jL4XNk6K8oHQaSWfMgCL7ji for z6Mkt67GdsW7715MEfRuP4pSZxJRJh6kj6Y48WRqVv4N1tRk +โœ“ Forked repository rad:z42hL2jL4XNk6K8oHQaSWfMgCL7ji for z6Mkt67GdsW7715MEfRuP4pSZxJRJh6kj6Y48WRqVv4N1tRk ``` Now, if we `rad inspect` the project's refs again we will see that we diff --git a/radicle-cli/examples/rad-id-collaboration.md b/radicle-cli/examples/rad-id-collaboration.md index cdcef3585..3d0a9b98e 100644 --- a/radicle-cli/examples/rad-id-collaboration.md +++ b/radicle-cli/examples/rad-id-collaboration.md @@ -20,7 +20,7 @@ $ rad clone rad:z42hL2jL4XNk6K8oHQaSWfMgCL7ji --scope followed โ”‚ Radicle Heartwood Protocol & Stack โ”‚ โ”‚ 0 issues ยท 0 patches โ”‚ โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ -Run `cd ./heartwood` to go to the project directory. +Run `cd ./heartwood` to go to the repository directory. $ cd ./heartwood $ git push rad master ``` @@ -78,7 +78,7 @@ $ rad clone rad:z42hL2jL4XNk6K8oHQaSWfMgCL7ji --scope followed โ”‚ Radicle Heartwood Protocol & Stack โ”‚ โ”‚ 0 issues ยท 0 patches โ”‚ โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ -Run `cd ./heartwood` to go to the project directory. +Run `cd ./heartwood` to go to the repository directory. $ cd ./heartwood $ git push rad master ``` diff --git a/radicle-cli/examples/rad-init-private-clone-seed.md b/radicle-cli/examples/rad-init-private-clone-seed.md index 083dea077..946b511c5 100644 --- a/radicle-cli/examples/rad-init-private-clone-seed.md +++ b/radicle-cli/examples/rad-init-private-clone-seed.md @@ -41,5 +41,5 @@ $ rad clone rad:z2ug5mwNKZB8KGpBDRTrWHAMbvHCu --seed z6MknSLrJoTcukLrE435hVNQT4J โ”‚ radicle heartwood protocol & stack โ”‚ โ”‚ 0 issues ยท 0 patches โ”‚ โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ -Run `cd ./heartwood` to go to the project directory. +Run `cd ./heartwood` to go to the repository directory. ``` diff --git a/radicle-cli/examples/rad-init-private.md b/radicle-cli/examples/rad-init-private.md index 9f7b0cbab..ec115e08d 100644 --- a/radicle-cli/examples/rad-init-private.md +++ b/radicle-cli/examples/rad-init-private.md @@ -3,11 +3,11 @@ Alice can initialize a *private* repo using the `--private` flag. ``` $ rad init --name heartwood --description "radicle heartwood protocol & stack" --no-confirm --private -Initializing private radicle ๐Ÿ‘พ project in . +Initializing private radicle ๐Ÿ‘พ repository in . -โœ“ Project heartwood created. +โœ“ Repository heartwood created. -Your project's Repository ID (RID) is rad:z2ug5mwNKZB8KGpBDRTrWHAMbvHCu. +Your Repository ID (RID) is rad:z2ug5mwNKZB8KGpBDRTrWHAMbvHCu. You can show it any time by running `rad .` from this directory. You have created a private repository. diff --git a/radicle-cli/examples/rad-init-sync-not-connected.md b/radicle-cli/examples/rad-init-sync-not-connected.md index e5da18b18..f690719b8 100644 --- a/radicle-cli/examples/rad-init-sync-not-connected.md +++ b/radicle-cli/examples/rad-init-sync-not-connected.md @@ -1,18 +1,18 @@ -When initializing a project without any peer connections, we get this output: +When initializing a repository without any peer connections, we get this output: ``` $ rad init --name heartwood --description "Radicle Heartwood Protocol & Stack" --no-confirm --public --scope followed -Initializing public radicle ๐Ÿ‘พ project in . +Initializing public radicle ๐Ÿ‘พ repository in . -โœ“ Project heartwood created. +โœ“ Repository heartwood created. -Your project's Repository ID (RID) is rad:z42hL2jL4XNk6K8oHQaSWfMgCL7ji. +Your Repository ID (RID) is rad:z42hL2jL4XNk6K8oHQaSWfMgCL7ji. You can show it any time by running `rad .` from this directory. โœ— Announcing.. -You are not connected to any peers. Your project will be announced as soon as your node establishes a connection with the network. +You are not connected to any peers. Your repository will be announced as soon as your node establishes a connection with the network. Check for peer connections with `rad node status`. To push changes, run `git push`. diff --git a/radicle-cli/examples/rad-init-sync-preferred.md b/radicle-cli/examples/rad-init-sync-preferred.md index 29b81803a..552c91ac2 100644 --- a/radicle-cli/examples/rad-init-sync-preferred.md +++ b/radicle-cli/examples/rad-init-sync-preferred.md @@ -1,18 +1,18 @@ -Let's try initializing a new project with a preferred seed configured. +Let's try initializing a new repository with a preferred seed configured. ``` $ rad init --name heartwood --description "Radicle Heartwood Protocol & Stack" --no-confirm --public --scope followed -Initializing public radicle ๐Ÿ‘พ project in . +Initializing public radicle ๐Ÿ‘พ repository in . -โœ“ Project heartwood created. +โœ“ Repository heartwood created. -Your project's Repository ID (RID) is rad:z3Rry7rpdWuGpfjPYGzdJKQADsoNW. +Your Repository ID (RID) is rad:z3Rry7rpdWuGpfjPYGzdJKQADsoNW. You can show it any time by running `rad .` from this directory. -โœ“ Project successfully synced to 1 node(s). +โœ“ Repository successfully synced to 1 node(s). -Your project has been synced to the network and is now discoverable by peers. +Your repository has been synced to the network and is now discoverable by peers. View it in your browser at: https://app.radicle.xyz/nodes/[...]/rad:z3Rry7rpdWuGpfjPYGzdJKQADsoNW diff --git a/radicle-cli/examples/rad-init-sync-timeout.md b/radicle-cli/examples/rad-init-sync-timeout.md index 836e1293b..324334985 100644 --- a/radicle-cli/examples/rad-init-sync-timeout.md +++ b/radicle-cli/examples/rad-init-sync-timeout.md @@ -4,17 +4,17 @@ as the node will keep attempting to sync in the background. ``` $ rad init --name heartwood --description "Radicle Heartwood Protocol & Stack" --no-confirm --public --scope followed -Initializing public radicle ๐Ÿ‘พ project in . +Initializing public radicle ๐Ÿ‘พ repository in . -โœ“ Project heartwood created. +โœ“ Repository heartwood created. -Your project's Repository ID (RID) is rad:z3Rry7rpdWuGpfjPYGzdJKQADsoNW. +Your Repository ID (RID) is rad:z3Rry7rpdWuGpfjPYGzdJKQADsoNW. You can show it any time by running `rad .` from this directory. -โœ“ Project successfully announced to the network. +โœ“ Repository successfully announced to the network. -Your project has been announced to the network and is now discoverable by peers. -You can check for any nodes that have replicated your project by running `rad sync status`. +Your repository has been announced to the network and is now discoverable by peers. +You can check for any nodes that have replicated your repository by running `rad sync status`. To push changes, run `git push`. ``` diff --git a/radicle-cli/examples/rad-init-sync.md b/radicle-cli/examples/rad-init-sync.md index 3a45fa67f..0b196b278 100644 --- a/radicle-cli/examples/rad-init-sync.md +++ b/radicle-cli/examples/rad-init-sync.md @@ -1,21 +1,21 @@ -To create your first radicle project, navigate to a git repository, and run +To create your first radicle repository, navigate to a git repository, and run the `init` command: ``` $ rad init --name heartwood --description "Radicle Heartwood Protocol & Stack" --no-confirm --public --scope followed -Initializing public radicle ๐Ÿ‘พ project in . +Initializing public radicle ๐Ÿ‘พ repository in . -โœ“ Project heartwood created. +โœ“ Repository heartwood created. -Your project's Repository ID (RID) is rad:z42hL2jL4XNk6K8oHQaSWfMgCL7ji. +Your Repository ID (RID) is rad:z42hL2jL4XNk6K8oHQaSWfMgCL7ji. You can show it any time by running `rad .` from this directory. -โœ“ Project successfully announced to the network. +โœ“ Repository successfully announced to the network. -Your project has been announced to the network and is now discoverable by peers. -You can check for any nodes that have replicated your project by running `rad sync status`. +Your repository has been announced to the network and is now discoverable by peers. +You can check for any nodes that have replicated your repository by running `rad sync status`. To push changes, run `git push`. ``` diff --git a/radicle-cli/examples/rad-init-with-existing-remote.md b/radicle-cli/examples/rad-init-with-existing-remote.md index 8c40e2816..6e4152999 100644 --- a/radicle-cli/examples/rad-init-with-existing-remote.md +++ b/radicle-cli/examples/rad-init-with-existing-remote.md @@ -22,14 +22,14 @@ Then we initialize. ``` $ rad init --name heartwood --description "Heartwood Protocol & Stack" --no-confirm --public -Initializing public radicle ๐Ÿ‘พ project in . +Initializing public radicle ๐Ÿ‘พ repository in . -โœ“ Project heartwood created. +โœ“ Repository heartwood created. -Your project's Repository ID (RID) is rad:z2D6wQnKapY7dn5meBnbH2rUKNZbT. +Your Repository ID (RID) is rad:z2D6wQnKapY7dn5meBnbH2rUKNZbT. You can show it any time by running `rad .` from this directory. -Your project will be announced to the network when you start your node. +Your repository will be announced to the network when you start your node. You can start your node with `rad node start`. To push changes, run `git push rad master`. ``` diff --git a/radicle-cli/examples/rad-init.md b/radicle-cli/examples/rad-init.md index a6ff82709..0743e5084 100644 --- a/radicle-cli/examples/rad-init.md +++ b/radicle-cli/examples/rad-init.md @@ -1,23 +1,23 @@ -To create your first radicle project, navigate to a git repository, and run the +To create your first radicle repository, navigate to a git repository, and run the `init` command. Make sure you have [authenticated](../rad-auth.md) beforehand. ``` $ rad init --name heartwood --description "Radicle Heartwood Protocol & Stack" --no-confirm --public -v -Initializing public radicle ๐Ÿ‘พ project in . +Initializing public radicle ๐Ÿ‘พ repository in . -โœ“ Project heartwood created. +โœ“ Repository heartwood created. { "name": "heartwood", "description": "Radicle Heartwood Protocol & Stack", "defaultBranch": "master" } -Your project's Repository ID (RID) is rad:z42hL2jL4XNk6K8oHQaSWfMgCL7ji. +Your Repository ID (RID) is rad:z42hL2jL4XNk6K8oHQaSWfMgCL7ji. You can show it any time by running `rad .` from this directory. -Your project will be announced to the network when you start your node. +Your repository will be announced to the network when you start your node. You can start your node with `rad node start`. To push changes, run `git push`. ``` diff --git a/radicle-cli/examples/rad-patch-pull-update.md b/radicle-cli/examples/rad-patch-pull-update.md index aed3c520e..b33db60f7 100644 --- a/radicle-cli/examples/rad-patch-pull-update.md +++ b/radicle-cli/examples/rad-patch-pull-update.md @@ -1,21 +1,21 @@ Let's look at how patch updates work. -Alice creates a project and Bob clones it. +Alice creates a repository and Bob clones it. ``` ~alice $ rad init --name heartwood --description "radicle heartwood protocol & stack" --no-confirm --public -Initializing public radicle ๐Ÿ‘พ project in . +Initializing public radicle ๐Ÿ‘พ repository in . -โœ“ Project heartwood created. +โœ“ Repository heartwood created. -Your project's Repository ID (RID) is rad:zhbMU4DUXrzB8xT6qAJh6yZ7bFMK. +Your Repository ID (RID) is rad:zhbMU4DUXrzB8xT6qAJh6yZ7bFMK. You can show it any time by running `rad .` from this directory. -โœ“ Project successfully announced to the network. +โœ“ Repository successfully announced to the network. -Your project has been announced to the network and is now discoverable by peers. -You can check for any nodes that have replicated your project by running `rad sync status`. +Your repository has been announced to the network and is now discoverable by peers. +You can check for any nodes that have replicated your repository by running `rad sync status`. To push changes, run `git push`. ``` @@ -33,7 +33,7 @@ $ rad clone rad:zhbMU4DUXrzB8xT6qAJh6yZ7bFMK โ”‚ radicle heartwood protocol & stack โ”‚ โ”‚ 0 issues ยท 0 patches โ”‚ โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ -Run `cd ./heartwood` to go to the project directory. +Run `cd ./heartwood` to go to the repository directory. ``` We fork the repository by pushing to `master`, and wait for Alice to sync diff --git a/radicle-cli/src/commands/auth.rs b/radicle-cli/src/commands/auth.rs index 30da2dc5a..a15a9a90e 100644 --- a/radicle-cli/src/commands/auth.rs +++ b/radicle-cli/src/commands/auth.rs @@ -139,11 +139,11 @@ pub fn init(options: Options) -> anyhow::Result<()> { term::success!("You're all set."); term::blank(); term::info!( - "To create a radicle project, run {} from a Git repository with at least one commit.", + "To create a Radicle repository, run {} from a Git repository with at least one commit.", term::format::command("rad init") ); term::info!( - "To clone a project, run {}. For example, {} clones the Radicle 'heartwood' project.", + "To clone a repository, run {}. For example, {} clones the Radicle 'heartwood' repository.", term::format::command("rad clone "), term::format::command("rad clone rad:z3gqcJUoA1n9HaHKufZs5FCSGazv5") ); diff --git a/radicle-cli/src/commands/checkout.rs b/radicle-cli/src/commands/checkout.rs index 116893d81..c285dd087 100644 --- a/radicle-cli/src/commands/checkout.rs +++ b/radicle-cli/src/commands/checkout.rs @@ -16,13 +16,15 @@ use crate::terminal::args::{Args, Error, Help}; pub const HELP: Help = Help { name: "checkout", - description: "Checkout a project into the local directory", + description: "Checkout a repository into the local directory", version: env!("CARGO_PKG_VERSION"), usage: r#" Usage rad checkout [--remote ] [