revamp documentation
This commit is contained in:
parent
3cc1c870ab
commit
0f22b8c2a3
11 changed files with 49 additions and 3 deletions
21
README.md
21
README.md
|
|
@ -355,11 +355,28 @@ This project has been the main focus
|
||||||
of my (non work) life for the past 3 year now
|
of my (non work) life for the past 3 year now
|
||||||
and I intend to continue working on this for a long time.
|
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)
|
discuss the details first. More details in [the contributing section](https://shb.skarabox.com/contributing.html)
|
||||||
of the manual.
|
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
|
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
|
possible. I want to upstream as much as possible. I will still take some time to experiment here but
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,4 @@
|
||||||
|
<!-- Read these docs at https://shb.skarabox.com -->
|
||||||
# Blocks {#blocks}
|
# Blocks {#blocks}
|
||||||
|
|
||||||
Blocks help you self-host apps or services. They implement a specific function like backup or secure
|
Blocks help you self-host apps or services. They implement a specific function like backup or secure
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,4 @@
|
||||||
|
<!-- Read these docs at https://shb.skarabox.com -->
|
||||||
# Contracts {#contracts}
|
# Contracts {#contracts}
|
||||||
|
|
||||||
A contract decouples modules that use a functionality from modules that provide it. A first
|
A contract decouples modules that use a functionality from modules that provide it. A first
|
||||||
|
|
|
||||||
|
|
@ -1,8 +1,28 @@
|
||||||
|
<!-- Read these docs at https://shb.skarabox.com -->
|
||||||
# Contributing {#contributing}
|
# Contributing {#contributing}
|
||||||
|
|
||||||
All issues and Pull Requests are welcome!
|
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.
|
first.
|
||||||
|
|
||||||
## Chat Support {#contributing-chat}
|
## Chat Support {#contributing-chat}
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,5 @@
|
||||||
# Taken nearly verbatim from https://github.com/nix-community/home-manager/pull/4673
|
# Taken nearly verbatim from https://github.com/nix-community/home-manager/pull/4673
|
||||||
|
# Read these docs online at https://shb.skarabox.com.
|
||||||
{ pkgs
|
{ pkgs
|
||||||
, buildPackages
|
, buildPackages
|
||||||
, lib
|
, lib
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,4 @@
|
||||||
|
<!-- Read these docs at https://shb.skarabox.com -->
|
||||||
# Demos {#demos}
|
# Demos {#demos}
|
||||||
|
|
||||||
These demos are showcasing what Self Host Blocks can do. They deploy a block or a service on a VM on
|
These demos are showcasing what Self Host Blocks can do. They deploy a block or a service on a VM on
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,4 @@
|
||||||
|
<!-- Read these docs at https://shb.skarabox.com -->
|
||||||
# Self Host Blocks Manual {#self-host-blocks-manual}
|
# Self Host Blocks Manual {#self-host-blocks-manual}
|
||||||
|
|
||||||
## Version @VERSION@
|
## Version @VERSION@
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,4 @@
|
||||||
|
<!-- Read these docs at https://shb.skarabox.com -->
|
||||||
# All Options {#all-options}
|
# All Options {#all-options}
|
||||||
|
|
||||||
```{=include=} options
|
```{=include=} options
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,4 @@
|
||||||
|
<!-- Read these docs at https://shb.skarabox.com -->
|
||||||
# Preface {#preface}
|
# Preface {#preface}
|
||||||
|
|
||||||
::: {.note}
|
::: {.note}
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,4 @@
|
||||||
|
<!-- Read these docs at https://shb.skarabox.com -->
|
||||||
# Services {#services}
|
# Services {#services}
|
||||||
|
|
||||||
Services are usually web applications that SHB help you self-host. Configuration of those is
|
Services are usually web applications that SHB help you self-host. Configuration of those is
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,4 @@
|
||||||
|
<!-- Read these docs at https://shb.skarabox.com -->
|
||||||
# Usage {#usage}
|
# Usage {#usage}
|
||||||
|
|
||||||
## Flake {#usage-flake}
|
## Flake {#usage-flake}
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue