~sircmpwn/sr.ht-docs

a50fdb6701b30d2cedb2943c7dde579b7268004d — Drew DeVault 7 days ago c53ccbe
Add initial docs for hub.sr.ht
4 files changed, 59 insertions(+), 0 deletions(-)

A hub.sr.ht/api.md
A hub.sr.ht/index.md
A hub.sr.ht/installation.md
M index.html
A hub.sr.ht/api.md => hub.sr.ht/api.md +1 -0
@@ 0,0 1,1 @@
The project hub does not yet offer an API. Stay tuned.

A hub.sr.ht/index.md => hub.sr.ht/index.md +26 -0
@@ 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

A hub.sr.ht/installation.md => hub.sr.ht/installation.md +22 -0
@@ 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)

M index.html => index.html +10 -0
@@ 79,6 79,16 @@ dt {
<dl class="row">
  <div class="col-md-4">
    <dt>
      <strong>Project hub</strong>
    </dt>
    <dd>
      <a href="/hub.sr.ht">User Manual</a>
      &mdash;
      <a href="/hub.sr.ht/api.md">API Reference</a>
    </dd>
  </div>
  <div class="col-md-4">
    <dt>
      <strong>git.sr.ht</strong>: git hosting
    </dt>
    <dd>