diff --git a/README.md b/README.md index 3da9c98..d30b965 100644 --- a/README.md +++ b/README.md @@ -355,11 +355,28 @@ This project has been the main focus of my (non work) life for the past 3 year now and I intend to continue working on this for a long time. -All issues and PRs are welcome. For PRs, if they are substantial changes, please open an issue to +All issues and PRs are welcome: + +- Use this project. Something does not make sense? Something's not working? +- Documentation. Something is not clear? +- New services. Have one of your preferred service not integrated yet? +- Better patterns. See something weird in the code? + +For PRs, if they are substantial changes, please open an issue to discuss the details first. More details in [the contributing section](https://shb.skarabox.com/contributing.html) of the manual. -Come hang out in the [Matrix channel](https://matrix.to/#/%23selfhostblocks%3Amatrix.org). :) +Issues that are being worked on are labeled with the [in progress][] label. +Before starting work on those, you might want to talk about it in the issue tracker +or in the [matrix][] channel. + +The prioritized issues are those belonging to the [next milestone][milestone]. +Those issues are not set in stone and I'd be very happy to solve +an issue an user has before scratching my own itch. + +[in progress]: https://github.com/ibizaman/selfhostblocks/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22in%20progress%22 +[matrix]: https://matrix.to/#/%23selfhostblocks%3Amatrix.org +[milestone]: https://github.com/ibizaman/selfhostblocks/milestones One aspect that's close to my heart is I intent to make SelfHostBlocks the lightest layer on top of nixpkgs as possible. I want to upstream as much as possible. I will still take some time to experiment here but diff --git a/docs/blocks.md b/docs/blocks.md index b89bb30..61f085b 100644 --- a/docs/blocks.md +++ b/docs/blocks.md @@ -1,3 +1,4 @@ + # Blocks {#blocks} Blocks help you self-host apps or services. They implement a specific function like backup or secure diff --git a/docs/contracts.md b/docs/contracts.md index 2640c69..d6ada44 100644 --- a/docs/contracts.md +++ b/docs/contracts.md @@ -1,3 +1,4 @@ + # Contracts {#contracts} A contract decouples modules that use a functionality from modules that provide it. A first diff --git a/docs/contributing.md b/docs/contributing.md index 33544da..02f9795 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -1,8 +1,28 @@ + # Contributing {#contributing} All issues and Pull Requests are welcome! -For Pull Requests, if they are substantial changes, please open an issue to discuss the details +- Use this project. Something does not make sense? Something's not working? +- Documentation. Something is not clear? +- New services. Have one of your preferred service not integrated yet? +- Better patterns. See something weird in the code? + +For PRs, if they are substantial changes, please open an issue to +discuss the details first. More details in [the contributing section](https://shb.skarabox.com/contributing.html) +of the manual. + +Issues that are being worked on are labeled with the [in progress][] label. +Before starting work on those, you might want to talk about it in the issue tracker +or in the [matrix][] channel. + +The prioritized issues are those belonging to the [next milestone][milestone]. +Those issues are not set in stone and I'd be very happy to solve +an issue an user has before scratching my own itch. + +[in progress]: https://github.com/ibizaman/selfhostblocks/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22in%20progress%22 +[matrix]: https://matrix.to/#/%23selfhostblocks%3Amatrix.org +[milestone]: https://github.com/ibizaman/selfhostblocks/milestones first. ## Chat Support {#contributing-chat} diff --git a/docs/default.nix b/docs/default.nix index 5bb2627..9a86b87 100644 --- a/docs/default.nix +++ b/docs/default.nix @@ -1,4 +1,5 @@ # Taken nearly verbatim from https://github.com/nix-community/home-manager/pull/4673 +# Read these docs online at https://shb.skarabox.com. { pkgs , buildPackages , lib diff --git a/docs/demos.md b/docs/demos.md index 730ee53..453f829 100644 --- a/docs/demos.md +++ b/docs/demos.md @@ -1,3 +1,4 @@ + # Demos {#demos} These demos are showcasing what Self Host Blocks can do. They deploy a block or a service on a VM on diff --git a/docs/manual.md b/docs/manual.md index 43757af..060bf09 100644 --- a/docs/manual.md +++ b/docs/manual.md @@ -1,3 +1,4 @@ + # Self Host Blocks Manual {#self-host-blocks-manual} ## Version @VERSION@ diff --git a/docs/options.md b/docs/options.md index 5c2dd31..5a4b030 100644 --- a/docs/options.md +++ b/docs/options.md @@ -1,3 +1,4 @@ + # All Options {#all-options} ```{=include=} options diff --git a/docs/preface.md b/docs/preface.md index 19460fb..25ea196 100644 --- a/docs/preface.md +++ b/docs/preface.md @@ -1,3 +1,4 @@ + # Preface {#preface} ::: {.note} diff --git a/docs/services.md b/docs/services.md index 432f5fe..fcce1c6 100644 --- a/docs/services.md +++ b/docs/services.md @@ -1,3 +1,4 @@ + # Services {#services} Services are usually web applications that SHB help you self-host. Configuration of those is diff --git a/docs/usage.md b/docs/usage.md index 99fa36d..1247aa7 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -1,3 +1,4 @@ + # Usage {#usage} ## Flake {#usage-flake}