diff options
| author | Drew DeVault <sir@cmpwn.com> | 2020-09-12 10:45:49 -0400 |
|---|---|---|
| committer | Drew DeVault <sir@cmpwn.com> | 2020-09-12 10:45:49 -0400 |
| commit | a50fdb6701b30d2cedb2943c7dde579b7268004d (patch) | |
| tree | 15b699acee8eda5e668b0ce257aac0c5a7966c2d /hub.sr.ht | |
| parent | c53ccbed796be79847affde659bed943e13cee70 (diff) | |
| download | sr.ht-docs-a50fdb6701b30d2cedb2943c7dde579b7268004d.tar.gz | |
Add initial docs for hub.sr.ht
Diffstat (limited to 'hub.sr.ht')
| -rw-r--r-- | hub.sr.ht/api.md | 1 | ||||
| -rw-r--r-- | hub.sr.ht/index.md | 26 | ||||
| -rw-r--r-- | hub.sr.ht/installation.md | 22 |
3 files changed, 49 insertions, 0 deletions
diff --git a/hub.sr.ht/api.md b/hub.sr.ht/api.md new file mode 100644 index 0000000..aedef0a --- /dev/null +++ b/hub.sr.ht/api.md @@ -0,0 +1 @@ +The project hub does not yet offer an API. Stay tuned. diff --git a/hub.sr.ht/index.md b/hub.sr.ht/index.md new file mode 100644 index 0000000..b1bf24d --- /dev/null +++ b/hub.sr.ht/index.md @@ -0,0 +1,26 @@ +--- +title: Project hub docs +--- + +[hub.sr.ht](https://sr.ht) (or the "project hub") is a service which indexes and +organizes projects on sr.ht, and the resources those projects use on other +services. + +**See also**: + +- [API reference](api.md) +- [Installation guide](installation.md) + +# Best practices for #tags + +Tags on hub.sr.ht aid in community builting and project discovery. If we're +consistent about how we use them, it can help meet those goals better. + +Here are some recommendations for your project tags: + +- Avoid adding tags for implementation language unless it matters (e.g. + language-specific libraries) +- Avoid adding tags for platform support unless your project is based on + platform-specific features (e.g. seccomp-related projects should use #linux) +- If there are multiple ways to word a tag (e.g. #gfx vs #graphics), check if + there's already an existing preference you can join diff --git a/hub.sr.ht/installation.md b/hub.sr.ht/installation.md new file mode 100644 index 0000000..2fdf384 --- /dev/null +++ b/hub.sr.ht/installation.md @@ -0,0 +1,22 @@ +--- +title: Project hub installation +--- + +[hub.sr.ht](https://sr.ht) (or the "project hub") indexes and organizes projects +for sr.ht communities. + +# Installation + +hub.sr.ht is a standard sr.ht web service and can be installed through the +[standard procedure](/installation.md). However, its utility depends on the +installation and configuration of at least one or two other web services. See +the top-level [installation guide](/installation.md) for a list of these +services. + +## Daemons + +- `hub.sr.ht`: the web service + +## Cronjobs + +(none) |