From eb95c4d8682fb5411ad2eb31bdb04fa6df23282c Mon Sep 17 00:00:00 2001 From: Chewing_Bever Date: Thu, 9 Jun 2022 10:25:36 +0200 Subject: [PATCH] docs: started new builds usage page --- docs/content/other/_index.md | 3 ++ docs/content/other/builds-in-depth.md | 4 +++ docs/content/usage/_index.md | 7 ++--- docs/content/usage/builds.md | 40 +++++++++++++++++++++++++++ docs/content/usage/repository.md | 3 ++ 5 files changed, 53 insertions(+), 4 deletions(-) create mode 100644 docs/content/other/_index.md create mode 100644 docs/content/other/builds-in-depth.md create mode 100644 docs/content/usage/builds.md diff --git a/docs/content/other/_index.md b/docs/content/other/_index.md new file mode 100644 index 0000000..394456b --- /dev/null +++ b/docs/content/other/_index.md @@ -0,0 +1,3 @@ +--- +weight: 100 +--- diff --git a/docs/content/other/builds-in-depth.md b/docs/content/other/builds-in-depth.md new file mode 100644 index 0000000..a6f0c21 --- /dev/null +++ b/docs/content/other/builds-in-depth.md @@ -0,0 +1,4 @@ +# Builds In-depth + +For those interested, this page describes how the build system works +internally. diff --git a/docs/content/usage/_index.md b/docs/content/usage/_index.md index bb0376f..1518e5e 100644 --- a/docs/content/usage/_index.md +++ b/docs/content/usage/_index.md @@ -1,4 +1,3 @@ -# Usage - -This section describes how to use the various parts of Vieter. It assumes you -have a Vieter repository server up and running. +--- +weight: 30 +--- diff --git a/docs/content/usage/builds.md b/docs/content/usage/builds.md new file mode 100644 index 0000000..db11bec --- /dev/null +++ b/docs/content/usage/builds.md @@ -0,0 +1,40 @@ +--- +weight: 20 +--- +# Building packages + +The automatic build system is what makes Vieter very useful as a replacement +for an AUR helper. It can perodically build packages & publish them to your +personal Vieter repository server, removing the need to build the packages +locally. + +## Adding builds + +Before the cron system can start building your package, you need to add its +info to the system. The Vieter repository server exposes an HTTP API for this +(see the [HTTP API Docs](https://rustybever.be/docs/vieter/api/) for more +info). For ease of use, the Vieter binary contains a CLI interface for +interacting with this API (see [Configuration](/configuration) for +configuration details). The [man +pages](https://rustybever.be/man/vieter/vieter-repos.1.html) describe this in +greater detail, but the basic usage is as follows: + +``` +vieter repos add some-url some-branch some-repository +``` + +Here, `some-url` is the URL of the Git repository containing the PKGBUILD. This +URL is passed to `git clone`, so the repository should be public. Vieter +expects the same format as an AUR Git repository, so you can directly use AUR +URLs here. + +`some-branch` is the branch of the Git repository the build should check out. +If you're using an AUR package, this should be `master`. + +Finally, `some-repo` is the repository to which the built package archives +should be published. + +The above command intentionally leaves out a few parameters to make the CLI +more useable. For information on how to modify all parameters using the CLI, +see +[vieter-repos-edit(1)](https://rustybever.be/man/vieter/vieter-repos-edit.1.html). diff --git a/docs/content/usage/repository.md b/docs/content/usage/repository.md index c30c8ca..1dc6bc6 100644 --- a/docs/content/usage/repository.md +++ b/docs/content/usage/repository.md @@ -1,3 +1,6 @@ +--- +weight: 10 +--- # Pacman repository The part of Vieter that users will interact with the most is the Pacman