Add YAMl frontmatter to all pages
This commit is contained in:
parent
8f4d5ccd27
commit
034d92ce14
|
@ -1,3 +1,7 @@
|
||||||
|
---
|
||||||
|
title: builds.sr.ht API reference
|
||||||
|
---
|
||||||
|
|
||||||
The builds.sr.ht API allows you to insert jobs, monitor their progress, and
|
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
|
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
|
brokered by meta.sr.ht. This API uses standard sr.ht error responses. All
|
||||||
|
|
|
@ -1,3 +1,7 @@
|
||||||
|
---
|
||||||
|
title: builds.sr.ht compatibility matrix
|
||||||
|
---
|
||||||
|
|
||||||
# Available Build Images
|
# Available Build Images
|
||||||
|
|
||||||
If you have any special requests, please [send an
|
If you have any special requests, please [send an
|
||||||
|
|
|
@ -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
|
[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
|
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
|
your specifications and run your scripts in it. This is generally used to
|
||||||
|
|
|
@ -1,3 +1,7 @@
|
||||||
|
---
|
||||||
|
title: builds.sr.ht installation
|
||||||
|
---
|
||||||
|
|
||||||
There are two components to builds.sr.ht: the job runner and the master server.
|
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
|
Typically installations will have one master and many runners distributed on
|
||||||
many servers, but both can be installed on the same server for small
|
many servers, but both can be installed on the same server for small
|
||||||
|
|
|
@ -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
|
A build manifest is a YAML file that describes how to perform a build. Here's an
|
||||||
example:
|
example:
|
||||||
|
|
||||||
|
|
|
@ -1,3 +1,7 @@
|
||||||
|
---
|
||||||
|
title: Private repos on builds.sr.ht
|
||||||
|
---
|
||||||
|
|
||||||
# Private repos in builds.sr.ht jobs
|
# Private repos in builds.sr.ht jobs
|
||||||
|
|
||||||
<div class="alert alert-danger">
|
<div class="alert alert-danger">
|
||||||
|
|
|
@ -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
|
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):
|
outcome of the job. The basic format is (in JSON):
|
||||||
|
|
||||||
|
|
|
@ -1,3 +1,7 @@
|
||||||
|
---
|
||||||
|
title: GitHub integration
|
||||||
|
---
|
||||||
|
|
||||||
dispatch.sr.ht supports various integrations with [GitHub](https://github.com).
|
dispatch.sr.ht supports various integrations with [GitHub](https://github.com).
|
||||||
Some tips are provided here.
|
Some tips are provided here.
|
||||||
|
|
||||||
|
|
|
@ -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
|
[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 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
|
to automate the submission of builds.sr.ht jobs in response to, for example, git
|
||||||
|
|
|
@ -1,3 +1,7 @@
|
||||||
|
---
|
||||||
|
title: git.sr.ht docs
|
||||||
|
---
|
||||||
|
|
||||||
[git.sr.ht](https://git.sr.ht) is a service for hosting git repositories on
|
[git.sr.ht](https://git.sr.ht) is a service for hosting git repositories on
|
||||||
sr.ht.
|
sr.ht.
|
||||||
|
|
||||||
|
|
|
@ -1,3 +1,7 @@
|
||||||
|
---
|
||||||
|
title: git.sr.ht installation
|
||||||
|
---
|
||||||
|
|
||||||
git.sr.ht is the git repository hosting service for the sr.ht network.
|
git.sr.ht is the git repository hosting service for the sr.ht network.
|
||||||
|
|
||||||
# Installation
|
# Installation
|
||||||
|
|
|
@ -1,3 +1,7 @@
|
||||||
|
---
|
||||||
|
title: git send-email
|
||||||
|
---
|
||||||
|
|
||||||
This horrible wall of text has been replaced with a much better interactive
|
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!
|
tutorial on using git send-email to send patches by email. Check it out here!
|
||||||
|
|
||||||
|
|
|
@ -1,3 +1,7 @@
|
||||||
|
---
|
||||||
|
title: lists.sr.ht API reference
|
||||||
|
---
|
||||||
|
|
||||||
# API Reference
|
# API Reference
|
||||||
|
|
||||||
The lists.sr.ht API allows you to browse, create, and subscribe to mailing lists
|
The lists.sr.ht API allows you to browse, create, and subscribe to mailing lists
|
||||||
|
|
|
@ -1,3 +1,7 @@
|
||||||
|
---
|
||||||
|
title: Mailing list ettiquette
|
||||||
|
---
|
||||||
|
|
||||||
Some email clients have popularized email usage patterns which are considered
|
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
|
poor form on many mailing lists, including sr.ht. Please review some of our
|
||||||
suggestions for participating more smoothly in discussions on the platform.
|
suggestions for participating more smoothly in discussions on the platform.
|
||||||
|
|
|
@ -1,3 +1,7 @@
|
||||||
|
---
|
||||||
|
title: lists.sr.ht docs
|
||||||
|
---
|
||||||
|
|
||||||
[lists.sr.ht](https://lists.sr.ht) is the sr.ht mailing list service.
|
[lists.sr.ht](https://lists.sr.ht) is the sr.ht mailing list service.
|
||||||
|
|
||||||
**See also**:
|
**See also**:
|
||||||
|
|
|
@ -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
|
lists.sr.ht is the mailing list service for lists.sr.ht. There are a number of
|
||||||
important components:
|
important components:
|
||||||
|
|
||||||
|
|
|
@ -1,3 +1,7 @@
|
||||||
|
---
|
||||||
|
title: man.sr.ht docs
|
||||||
|
---
|
||||||
|
|
||||||
[man.sr.ht](https://man.sr.ht/) is a git-powered wiki that can host
|
[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
|
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).
|
(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
|
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.
|
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
|
||||||
|
|
||||||
Publishing your changes is as easy as committing them and pushing them
|
Publishing your changes is as easy as committing them and pushing them
|
||||||
|
|
|
@ -1,3 +1,7 @@
|
||||||
|
---
|
||||||
|
title: Markdown on sourcehut
|
||||||
|
---
|
||||||
|
|
||||||
Across the site, sr.ht uses a consistent Markdown syntax based on Python's
|
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
|
[Markdown](https://pypi.python.org/pypi/Markdown) package, which implements John
|
||||||
Gruber's [original Markdown
|
Gruber's [original Markdown
|
||||||
|
|
|
@ -1,3 +1,7 @@
|
||||||
|
---
|
||||||
|
title: meta.sr.ht API
|
||||||
|
---
|
||||||
|
|
||||||
# meta.sr.ht API
|
# meta.sr.ht API
|
||||||
|
|
||||||
There are two primary APIs for accessing meta.sr.ht programmatically:
|
There are two primary APIs for accessing meta.sr.ht programmatically:
|
||||||
|
|
|
@ -1,3 +0,0 @@
|
||||||
# Delegated OAuth
|
|
||||||
|
|
||||||
TODO: write this doc
|
|
|
@ -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
|
[meta.sr.ht](https://meta.sr.ht) is a service on sr.ht that manages your user
|
||||||
account.
|
account.
|
||||||
|
|
||||||
|
|
|
@ -1,3 +1,7 @@
|
||||||
|
---
|
||||||
|
title: meta.sr.ht installation
|
||||||
|
---
|
||||||
|
|
||||||
meta.sr.ht is the central autentication service and service bus for the sr.ht
|
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
|
network, and a working meta.sr.ht is a basic requirement of running any other
|
||||||
sr.ht software.
|
sr.ht software.
|
||||||
|
|
|
@ -1,3 +1,7 @@
|
||||||
|
---
|
||||||
|
title: meta.sr.ht OAuth Reference
|
||||||
|
---
|
||||||
|
|
||||||
# meta.sr.ht OAuth API
|
# meta.sr.ht OAuth API
|
||||||
|
|
||||||
Authentication with all sr.ht services is done with OAuth and is governed by
|
Authentication with all sr.ht services is done with OAuth and is governed by
|
||||||
|
|
|
@ -1,3 +1,7 @@
|
||||||
|
---
|
||||||
|
title: meta.sr.ht API reference
|
||||||
|
---
|
||||||
|
|
||||||
# meta.sr.ht user API
|
# meta.sr.ht user API
|
||||||
|
|
||||||
The meta.sr.ht API allows you to view and edit user information on meta.sr.ht
|
The meta.sr.ht API allows you to view and edit user information on meta.sr.ht
|
||||||
|
|
|
@ -1,3 +1,7 @@
|
||||||
|
---
|
||||||
|
title: paste.sr.ht API reference
|
||||||
|
---
|
||||||
|
|
||||||
# API Reference
|
# API Reference
|
||||||
|
|
||||||
The paste.sr.ht API allows you to browse and create pastes on paste.sr.ht
|
The paste.sr.ht API allows you to browse and create pastes on paste.sr.ht
|
||||||
|
|
|
@ -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
|
[paste.sr.ht](https://paste.sr.ht) is an ad-hoc text file hosting service on
|
||||||
sr.ht.
|
sr.ht.
|
||||||
|
|
||||||
|
|
|
@ -1,3 +1,7 @@
|
||||||
|
---
|
||||||
|
title: paste.sr.ht installation
|
||||||
|
---
|
||||||
|
|
||||||
# Installation
|
# Installation
|
||||||
|
|
||||||
paste.sr.ht is a standard sr.ht web service and can be installed through the
|
paste.sr.ht is a standard sr.ht web service and can be installed through the
|
||||||
|
|
|
@ -1,3 +1,7 @@
|
||||||
|
---
|
||||||
|
title: General resources
|
||||||
|
---
|
||||||
|
|
||||||
Here are some general resources about sr.ht as a whole.
|
Here are some general resources about sr.ht as a whole.
|
||||||
|
|
||||||
# Billing
|
# Billing
|
||||||
|
|
|
@ -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
|
[todo.sr.ht](https://todo.sr.ht/) is an issue tracker that can be used for
|
||||||
your projects.
|
your projects.
|
||||||
|
|
||||||
|
|
|
@ -1,3 +1,7 @@
|
||||||
|
---
|
||||||
|
title: Integrating builds.sr.ht with GitHub
|
||||||
|
---
|
||||||
|
|
||||||
# Integrating builds.sr.ht with GitHub
|
# Integrating builds.sr.ht with GitHub
|
||||||
|
|
||||||
This is an adaptation of our [getting started with
|
This is an adaptation of our [getting started with
|
||||||
|
|
|
@ -1,3 +1,7 @@
|
||||||
|
---
|
||||||
|
title: builds.sr.ht tutorials
|
||||||
|
---
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
Ready to do more with builds.sr.ht? Here is a collection of useful tutorials
|
Ready to do more with builds.sr.ht? Here is a collection of useful tutorials
|
||||||
for setting up various kinds of build automations.
|
for setting up various kinds of build automations.
|
||||||
|
|
|
@ -1,3 +1,7 @@
|
||||||
|
---
|
||||||
|
title: Handling secrets in your build manifests
|
||||||
|
---
|
||||||
|
|
||||||
# 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
|
builds.sr.ht can be used to automate the deployment of websites, signing of
|
||||||
|
|
|
@ -1,3 +1,7 @@
|
||||||
|
---
|
||||||
|
title: Getting started with builds.sr.ht
|
||||||
|
---
|
||||||
|
|
||||||
# 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
|
builds.sr.ht is our build automation platform. We're going to walk through the
|
||||||
|
|
|
@ -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
|
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
|
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.
|
languages, and easy to read. Read at least the first 3 chapters.
|
||||||
|
|
Loading…
Reference in New Issue