vole
Clone
Read only, no credentials:
https://rodent.software/git/vole.git
Write over SSH with a registered key:
git clone ssh://git@0.0.0.0:2222/vole.git
A free and open-source forge that lives in your Git repo.
Unify terminology across the web UI and docs
ab326d3ac1fd947a9df45f31f6dc10ab38627882 · Keenan Nemetz · 14d ago · parent 5b814e99
Unify terminology across the web UI and docs Use account, repository, change request, enrollment link, instance admin, and sign in/out consistently. Rename the access guide to accounts-and-access.md, update its links, and record the canonical terms and retained command/URL spellings in the documentation index.
docs/README.md +25−4
| @@ -1,7 +1,7 @@ | |||
| 1 | 1 | # Vole documentation | |
| 2 | 2 | ||
| 3 | Vole is a small but mighty software forge that lives in your Git repo. It is for | ||
| 4 | developers and small teams who want their project to keep working even when | ||
| 3 | Vole is a small but mighty software forge that lives in your Git repository. It is for | ||
| 4 | developers and small teams who want their repository to keep working even when | ||
| 5 | 5 | someone else's cloud does not. | |
| 6 | 6 | ||
| 7 | 7 | New to Vole? Start with [Getting started](getting-started.md). It takes you from a | |
| @@ -15,7 +15,7 @@ After that, pick the page that matches what you want to do. | |||
| 15 | 15 | |---|---| | |
| 16 | 16 | | [Getting started](getting-started.md) | Build Vole, create an account, and make your first repository | | |
| 17 | 17 | | [Issues](issues.md) | Track bugs and tasks, comment on them, and edit them | | |
| 18 | | [Change requests](change-requests.md) | Ask for a change to be reviewed, approved, and merged | | ||
| 18 | | [Change requests](change-requests.md) | Ask for a change request to be reviewed, approved, and merged | | ||
| 19 | 19 | | [Workflows](workflows.md) | Add workflows, define jobs, and publish artifacts | | |
| 20 | 20 | | [Runners](runner.md) | Start a machine, execute jobs, and report results | | |
| 21 | 21 | | [LFS](lfs.md) | Store large files and lock files that Git cannot merge | | |
| @@ -34,7 +34,7 @@ After that, pick the page that matches what you want to do. | |||
| 34 | 34 | | Page | What it helps you do | | |
| 35 | 35 | |---|---| | |
| 36 | 36 | | [Configuration](configuration.md) | Change addresses, limits, and site settings | | |
| 37 | | [Users and access](users-and-access.md) | Add people, manage SSH keys, and set permissions | | ||
| 37 | | [Accounts and access](accounts-and-access.md) | Add accounts, manage SSH keys, and set permissions | | ||
| 38 | 38 | | [Operations](operations.md) | Back up, recover, and clean up an instance | | |
| 39 | 39 | | [Packages](packaging.md) | Build, install, and upgrade a `.deb` or `.rpm` | | |
| 40 | 40 | | [CLI reference](cli.md) | Look up a command or option | | |
| @@ -44,6 +44,27 @@ After that, pick the page that matches what you want to do. | |||
| 44 | 44 | [Architecture](architecture.md) explains how trust, storage, and the code are | |
| 45 | 45 | organized. | |
| 46 | 46 | ||
| 47 | ## Terminology | ||
| 48 | |||
| 49 | Use one word for each concept, in the interface and the guides: | ||
| 50 | |||
| 51 | - **account**: the identity that owns keys, passkeys, sessions, and roles. The CLI | ||
| 52 | spells its commands `vole admin user ...` and the database file is | ||
| 53 | `data/users.db`; in prose it is still an account. | ||
| 54 | - **repository**: the Git repository and what belongs to it. The CLI uses `repo` | ||
| 55 | and URLs use `/r/<name>`; do not call it a project. | ||
| 56 | - **change request**: a proposed branch reviewed before landing. The CLI uses | ||
| 57 | `change` and the route is `/requests`. | ||
| 58 | - **enrollment link**: the one-time link that lets someone register a passkey and | ||
| 59 | sign in. The CLI command is `user invite`, and some code calls it an invite. | ||
| 60 | - **instance admin**: the instance-wide `admin` role. Say "instance admin", not | ||
| 61 | "administrator", when that is what you mean. | ||
| 62 | - **sign in** / **sign out**: the browser action. `login` and `logout` remain in | ||
| 63 | routes, setting names, and code. | ||
| 64 | |||
| 65 | File names, command names, and URL paths keep their historical spellings; the | ||
| 66 | words above are what the interface and documentation should say. | ||
| 67 | |||
| 47 | 68 | ## A few conventions | |
| 48 | 69 | ||
| 49 | 70 | - Examples assume `vole` is on your `PATH`, or that you are running `./vole` from | |