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.
Docs: rewrite the README and organize the guides
520470e19cd906bd6fff987e2d132d793ce56486 · Keenan Nemetz · 16d ago · parent c5902451
Docs: rewrite the README and organize the guides Replace the long README with a landing page, split feature details into focused guides, and remove the roadmap and spike notes. Update comments that referenced them.
docs/README.md +48
| @@ -0,0 +1,48 @@ | |||
| 1 | # Vole documentation | ||
| 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 | ||
| 5 | someone else's cloud does not. | ||
| 6 | |||
| 7 | New to Vole? Start with [Getting started](getting-started.md). It takes you from a | ||
| 8 | source checkout to a repository you can clone. | ||
| 9 | |||
| 10 | After that, pick the page that matches what you want to do. | ||
| 11 | |||
| 12 | ## Everyday use | ||
| 13 | |||
| 14 | | Page | What it helps you do | | ||
| 15 | |---|---| | ||
| 16 | | [Getting started](getting-started.md) | Build Vole, create an account, and make your first repository | | ||
| 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 | | ||
| 19 | | [CI](ci.md) | Add workflows, run builds, and collect artifacts | | ||
| 20 | | [LFS](lfs.md) | Store large files and lock files that Git cannot merge | | ||
| 21 | | [Releases](releases.md) | Publish a release with notes, source archives, and binaries | | ||
| 22 | | [Sites](sites.md) | Serve a repository branch as a website | | ||
| 23 | |||
| 24 | ## Running an instance | ||
| 25 | |||
| 26 | | Page | What it helps you do | | ||
| 27 | |---|---| | ||
| 28 | | [Configuration](configuration.md) | Change addresses, limits, and site settings | | ||
| 29 | | [Users and access](users-and-access.md) | Add people, manage SSH keys, and set permissions | | ||
| 30 | | [Operations](operations.md) | Back up, recover, and clean up an instance | | ||
| 31 | | [CLI reference](cli.md) | Look up a command or option | | ||
| 32 | |||
| 33 | ## Design | ||
| 34 | |||
| 35 | [Architecture](architecture.md) explains how trust, storage, and the code are | ||
| 36 | organized. | ||
| 37 | |||
| 38 | ## A few conventions | ||
| 39 | |||
| 40 | - Examples assume `vole` is on your `PATH`, or that you are running `./vole` from | ||
| 41 | the repository root. | ||
| 42 | - Use `--remote <name>` when a clone has more than one remote. The default is | ||
| 43 | `origin`. | ||
| 44 | - Commands accept options in the same styles Git does: `--long value`, | ||
| 45 | `--long=value`, `-o value`, `-ovalue`, repeated options, and `--` to stop | ||
| 46 | option parsing. | ||
| 47 | - Commands that write data need a Git remote. Read-only commands such as | ||
| 48 | `vole issue list` work from a clone without network access. | ||