diff options
| author | Arun Isaac | 2022-03-19 23:48:17 +0530 |
|---|---|---|
| committer | Arun Isaac | 2022-03-19 23:51:28 +0530 |
| commit | 85e1a38692c3833c2a99540793bcc81fb9820617 (patch) | |
| tree | 7e843a3bc5fabc39d0c2249fdceac20f2330a4b3 | |
| parent | 0e7d98e4aa699e5e92de0864b0eb57a2d787c8c7 (diff) | |
| download | guix-forge-85e1a38692c3833c2a99540793bcc81fb9820617.tar.gz guix-forge-85e1a38692c3833c2a99540793bcc81fb9820617.tar.lz guix-forge-85e1a38692c3833c2a99540793bcc81fb9820617.zip | |
doc: List software components used by guix-forge.
* README.org, doc/forge.skb (Introduction): List software components
used by guix-forge.
| -rw-r--r-- | README.org | 9 | ||||
| -rw-r--r-- | doc/forge.skb | 13 |
2 files changed, 22 insertions, 0 deletions
@@ -2,6 +2,15 @@ /guix-forge/ is a Guix service that lets you run a complete [[https://en.wikipedia.org/wiki/Forge_(software)][software forge]] in the manner of GitHub, GitLab, etc. Unlike other free software forges such as GitLab, Gitea, etc., /guix-forge/ is not a monolith but is an assemblage of several pieces of server software wired up to function as one. In this sense, it is a /meta-service/. /guix-forge/ does for software forges what [[https://mailinabox.email/][Mail-in-a-Box]] does for email. +/guix-forge/ integrates the following software components: + +- [X] laminar for continuous integration +- [ ] web server to serve static project sites +- [ ] cgit to serve project git repositories on the web +- [ ] public-inbox for project discussions + +A choice of different software components may be offered provided it does not complicate the interface too much. + /guix-forge/ is provided on a best effort basis. Its design is unstable, and open to change. We will try our best to not break your system configuration often, but it might happen. * Installation diff --git a/doc/forge.skb b/doc/forge.skb index d56a6f7..3bfbcf2 100644 --- a/doc/forge.skb +++ b/doc/forge.skb @@ -32,6 +32,19 @@ software wired up to function as one. In this sense, it is a ,(emph "meta-service"). guix-forge does for software forges what ,(ref :url "https://mailinabox.email/" :text "Mail-in-a-Box") does for email.]) + (p [guix-forge integrates the following software components:] + (itemize + (item [,(ref :url "https://laminar.ohwg.net/" :text "laminar") +for continuous integration]))) + (p [In the future, it will also provide:] + (itemize + (item [web server to serve static project sites]) + (item [,(ref :url "https://git.zx2c4.com/cgit/" :text "cgit") +to serve project git repositories on the web]) + (item [,(ref :url "https://public-inbox.org/README.html" +:text "public-inbox") for project discussions]))) + (p [A choice of different software components may be offered +provided it does not complicate the interface too much.]) (p [guix-forge is provided on a best effort basis. Its design is unstable, and open to change. We will try our best to not break your system configuration often, but it might happen.]) |