Add YAMl frontmatter to all pages

This commit is contained in:
Drew DeVault 2019-04-12 11:56:09 -04:00
parent 8f4d5ccd27
commit 034d92ce14
34 changed files with 147 additions and 3 deletions

View File

@ -1,3 +1,7 @@
---
title: builds.sr.ht API reference
---
The builds.sr.ht API allows you to insert jobs, monitor their progress, and
access some information about the build system. Authentication to this API is
brokered by meta.sr.ht. This API uses standard sr.ht error responses. All

View File

@ -1,3 +1,7 @@
---
title: builds.sr.ht compatibility matrix
---
# Available Build Images
If you have any special requests, please [send an

View File

@ -1,3 +1,7 @@
---
title: builds.sr.ht docs
---
[builds.sr.ht](https://builds.sr.ht) is a service on sr.ht that allows you to
submit "build manifests" for us to work on. We spin up a virtual machine per
your specifications and run your scripts in it. This is generally used to

View File

@ -1,3 +1,7 @@
---
title: builds.sr.ht installation
---
There are two components to builds.sr.ht: the job runner and the master server.
Typically installations will have one master and many runners distributed on
many servers, but both can be installed on the same server for small

View File

@ -1,3 +1,7 @@
---
title: Build manifest reference
---
A build manifest is a YAML file that describes how to perform a build. Here's an
example:

View File

@ -1,3 +1,7 @@
---
title: Private repos on builds.sr.ht
---
# Private repos in builds.sr.ht jobs
<div class="alert alert-danger">

View File

@ -1,3 +1,7 @@
---
title: Build triggers reference
---
At the end of a job or a job group, you can execute triggers based on the
outcome of the job. The basic format is (in JSON):

View File

@ -1,3 +1,7 @@
---
title: GitHub integration
---
dispatch.sr.ht supports various integrations with [GitHub](https://github.com).
Some tips are provided here.

View File

@ -1,3 +1,7 @@
---
title: dispatch.sr.ht docs
---
[dispatch.sr.ht](https://dispatch.sr.ht) is a service on sr.ht that can be used
to automate tasks in response to various events. It's often used, for example,
to automate the submission of builds.sr.ht jobs in response to, for example, git

View File

@ -1,3 +1,7 @@
---
title: git.sr.ht docs
---
[git.sr.ht](https://git.sr.ht) is a service for hosting git repositories on
sr.ht.

View File

@ -1,3 +1,7 @@
---
title: git.sr.ht installation
---
git.sr.ht is the git repository hosting service for the sr.ht network.
# Installation

View File

@ -1,3 +1,7 @@
---
title: git send-email
---
This horrible wall of text has been replaced with a much better interactive
tutorial on using git send-email to send patches by email. Check it out here!

View File

@ -1,3 +1,7 @@
---
title: lists.sr.ht API reference
---
# API Reference
The lists.sr.ht API allows you to browse, create, and subscribe to mailing lists

View File

@ -1,3 +1,7 @@
---
title: Mailing list ettiquette
---
Some email clients have popularized email usage patterns which are considered
poor form on many mailing lists, including sr.ht. Please review some of our
suggestions for participating more smoothly in discussions on the platform.

View File

@ -1,3 +1,7 @@
---
title: lists.sr.ht docs
---
[lists.sr.ht](https://lists.sr.ht) is the sr.ht mailing list service.
**See also**:

View File

@ -1,3 +1,7 @@
---
title: lists.sr.ht installation
---
lists.sr.ht is the mailing list service for lists.sr.ht. There are a number of
important components:

View File

@ -1,3 +1,7 @@
---
title: man.sr.ht docs
---
[man.sr.ht](https://man.sr.ht/) is a git-powered wiki that can host
documentation for your projects. Click "create wiki" in the sidebar
(or above if viewing on mobile) to get started (you will have to log in first).
@ -19,6 +23,21 @@ the site](/markdown). Each page will be made available at the URL of the path to
the file, except for `index.md` which is also shown at the top-level of each
directory. Other kinds of files (html, images, etc) will not be served.
## Frontmatter
You may optionally begin a file with this pattern:
```
---
# YAML goes here
---
```
To add some extra metadata to your pages. The currently supported properties
are:
- **title**: set the article title
## Publishing your changes
Publishing your changes is as easy as committing them and pushing them

View File

@ -1,3 +1,7 @@
---
title: Markdown on sourcehut
---
Across the site, sr.ht uses a consistent Markdown syntax based on Python's
[Markdown](https://pypi.python.org/pypi/Markdown) package, which implements John
Gruber's [original Markdown

View File

@ -1,3 +1,7 @@
---
title: meta.sr.ht API
---
# meta.sr.ht API
There are two primary APIs for accessing meta.sr.ht programmatically:

View File

@ -1,3 +0,0 @@
# Delegated OAuth
TODO: write this doc

View File

@ -1,3 +1,7 @@
---
title: meta.sr.ht docs
---
[meta.sr.ht](https://meta.sr.ht) is a service on sr.ht that manages your user
account.

View File

@ -1,3 +1,7 @@
---
title: meta.sr.ht installation
---
meta.sr.ht is the central autentication service and service bus for the sr.ht
network, and a working meta.sr.ht is a basic requirement of running any other
sr.ht software.

View File

@ -1,3 +1,7 @@
---
title: meta.sr.ht OAuth Reference
---
# meta.sr.ht OAuth API
Authentication with all sr.ht services is done with OAuth and is governed by

View File

@ -1,3 +1,7 @@
---
title: meta.sr.ht API reference
---
# meta.sr.ht user API
The meta.sr.ht API allows you to view and edit user information on meta.sr.ht

View File

@ -1,3 +1,7 @@
---
title: paste.sr.ht API reference
---
# API Reference
The paste.sr.ht API allows you to browse and create pastes on paste.sr.ht

View File

@ -1,3 +1,7 @@
---
title: paste.sr.ht docs
---
[paste.sr.ht](https://paste.sr.ht) is an ad-hoc text file hosting service on
sr.ht.

View File

@ -1,3 +1,7 @@
---
title: paste.sr.ht installation
---
# Installation
paste.sr.ht is a standard sr.ht web service and can be installed through the

View File

@ -1,3 +1,7 @@
---
title: General resources
---
Here are some general resources about sr.ht as a whole.
# Billing

View File

@ -1,3 +1,7 @@
---
title: todo.sr.ht docs
---
[todo.sr.ht](https://todo.sr.ht/) is an issue tracker that can be used for
your projects.

View File

@ -1,3 +1,7 @@
---
title: Integrating builds.sr.ht with GitHub
---
# Integrating builds.sr.ht with GitHub
This is an adaptation of our [getting started with

View File

@ -1,3 +1,7 @@
---
title: builds.sr.ht tutorials
---
<p>
Ready to do more with builds.sr.ht? Here is a collection of useful tutorials
for setting up various kinds of build automations.

View File

@ -1,3 +1,7 @@
---
title: Handling secrets in your build manifests
---
# Handling secrets in your build manifests
builds.sr.ht can be used to automate the deployment of websites, signing of

View File

@ -1,3 +1,7 @@
---
title: Getting started with builds.sr.ht
---
# Getting started with builds.sr.ht
builds.sr.ht is our build automation platform. We're going to walk through the

View File

@ -1,3 +1,7 @@
---
title: Setting up your account and first git repository
---
If this is your first time using git, we recommend starting with the [Git
Book](https://git-scm.com/book/en/v2). It's free, translated into many
languages, and easy to read. Read at least the first 3 chapters.