diff --git a/builds.sr.ht/api.md b/builds.sr.ht/api.md index f9f1754..8c04186 100644 --- a/builds.sr.ht/api.md +++ b/builds.sr.ht/api.md @@ -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 diff --git a/builds.sr.ht/compatibility.md b/builds.sr.ht/compatibility.md index c60389a..9e281cb 100644 --- a/builds.sr.ht/compatibility.md +++ b/builds.sr.ht/compatibility.md @@ -1,3 +1,7 @@ +--- +title: builds.sr.ht compatibility matrix +--- + # Available Build Images If you have any special requests, please [send an diff --git a/builds.sr.ht/index.md b/builds.sr.ht/index.md index bd89f0d..b3f4fc2 100644 --- a/builds.sr.ht/index.md +++ b/builds.sr.ht/index.md @@ -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 diff --git a/builds.sr.ht/installation.md b/builds.sr.ht/installation.md index c9cebd2..bd4942b 100644 --- a/builds.sr.ht/installation.md +++ b/builds.sr.ht/installation.md @@ -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 diff --git a/builds.sr.ht/manifest.md b/builds.sr.ht/manifest.md index fc38d27..c366edd 100644 --- a/builds.sr.ht/manifest.md +++ b/builds.sr.ht/manifest.md @@ -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: diff --git a/builds.sr.ht/private-repos.md b/builds.sr.ht/private-repos.md index 9231517..7735288 100644 --- a/builds.sr.ht/private-repos.md +++ b/builds.sr.ht/private-repos.md @@ -1,3 +1,7 @@ +--- +title: Private repos on builds.sr.ht +--- + # Private repos in builds.sr.ht jobs
diff --git a/builds.sr.ht/triggers.md b/builds.sr.ht/triggers.md index 50e040d..dc0ffea 100644 --- a/builds.sr.ht/triggers.md +++ b/builds.sr.ht/triggers.md @@ -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): diff --git a/dispatch.sr.ht/github.md b/dispatch.sr.ht/github.md index 200b7e5..d32d38c 100644 --- a/dispatch.sr.ht/github.md +++ b/dispatch.sr.ht/github.md @@ -1,3 +1,7 @@ +--- +title: GitHub integration +--- + dispatch.sr.ht supports various integrations with [GitHub](https://github.com). Some tips are provided here. diff --git a/dispatch.sr.ht/index.md b/dispatch.sr.ht/index.md index bbb6c22..e046f0e 100644 --- a/dispatch.sr.ht/index.md +++ b/dispatch.sr.ht/index.md @@ -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 diff --git a/git.sr.ht/index.md b/git.sr.ht/index.md index 01cc7bb..a6ec18e 100644 --- a/git.sr.ht/index.md +++ b/git.sr.ht/index.md @@ -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. diff --git a/git.sr.ht/installation.md b/git.sr.ht/installation.md index fc04bb6..d653f6c 100644 --- a/git.sr.ht/installation.md +++ b/git.sr.ht/installation.md @@ -1,3 +1,7 @@ +--- +title: git.sr.ht installation +--- + git.sr.ht is the git repository hosting service for the sr.ht network. # Installation diff --git a/git.sr.ht/send-email.md b/git.sr.ht/send-email.md index 907f082..28ebd23 100644 --- a/git.sr.ht/send-email.md +++ b/git.sr.ht/send-email.md @@ -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! diff --git a/lists.sr.ht/api.md b/lists.sr.ht/api.md index 42a941f..3e7a677 100644 --- a/lists.sr.ht/api.md +++ b/lists.sr.ht/api.md @@ -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 diff --git a/lists.sr.ht/etiquette.md b/lists.sr.ht/etiquette.md index 11b7b48..a067453 100644 --- a/lists.sr.ht/etiquette.md +++ b/lists.sr.ht/etiquette.md @@ -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. diff --git a/lists.sr.ht/index.md b/lists.sr.ht/index.md index 67a4e12..5061a86 100644 --- a/lists.sr.ht/index.md +++ b/lists.sr.ht/index.md @@ -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**: diff --git a/lists.sr.ht/installation.md b/lists.sr.ht/installation.md index 15d3e9e..66f83fc 100644 --- a/lists.sr.ht/installation.md +++ b/lists.sr.ht/installation.md @@ -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: diff --git a/man.sr.ht/index.md b/man.sr.ht/index.md index bb3f6c3..aacd017 100644 --- a/man.sr.ht/index.md +++ b/man.sr.ht/index.md @@ -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 diff --git a/markdown/index.md b/markdown/index.md index 59c243d..4837b34 100644 --- a/markdown/index.md +++ b/markdown/index.md @@ -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 diff --git a/meta.sr.ht/api.md b/meta.sr.ht/api.md index d291a03..45fbe7d 100644 --- a/meta.sr.ht/api.md +++ b/meta.sr.ht/api.md @@ -1,3 +1,7 @@ +--- +title: meta.sr.ht API +--- + # meta.sr.ht API There are two primary APIs for accessing meta.sr.ht programmatically: diff --git a/meta.sr.ht/delegated-oauth.md b/meta.sr.ht/delegated-oauth.md deleted file mode 100644 index 56a6895..0000000 --- a/meta.sr.ht/delegated-oauth.md +++ /dev/null @@ -1,3 +0,0 @@ -# Delegated OAuth - -TODO: write this doc diff --git a/meta.sr.ht/index.md b/meta.sr.ht/index.md index 8eb8f7b..c8db112 100644 --- a/meta.sr.ht/index.md +++ b/meta.sr.ht/index.md @@ -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. diff --git a/meta.sr.ht/installation.md b/meta.sr.ht/installation.md index 472d8d5..377112f 100644 --- a/meta.sr.ht/installation.md +++ b/meta.sr.ht/installation.md @@ -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. diff --git a/meta.sr.ht/oauth-api.md b/meta.sr.ht/oauth-api.md index cff5357..634d17d 100644 --- a/meta.sr.ht/oauth-api.md +++ b/meta.sr.ht/oauth-api.md @@ -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 diff --git a/meta.sr.ht/user-api.md b/meta.sr.ht/user-api.md index 36ceac8..ee5fb1c 100644 --- a/meta.sr.ht/user-api.md +++ b/meta.sr.ht/user-api.md @@ -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 diff --git a/paste.sr.ht/api.md b/paste.sr.ht/api.md index e5766f9..aaac2b6 100644 --- a/paste.sr.ht/api.md +++ b/paste.sr.ht/api.md @@ -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 diff --git a/paste.sr.ht/index.md b/paste.sr.ht/index.md index edd99c4..84f6366 100644 --- a/paste.sr.ht/index.md +++ b/paste.sr.ht/index.md @@ -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. diff --git a/paste.sr.ht/installation.md b/paste.sr.ht/installation.md index fc9c122..d43ba19 100644 --- a/paste.sr.ht/installation.md +++ b/paste.sr.ht/installation.md @@ -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 diff --git a/sr.ht/index.md b/sr.ht/index.md index 6e2604b..b629761 100644 --- a/sr.ht/index.md +++ b/sr.ht/index.md @@ -1,3 +1,7 @@ +--- +title: General resources +--- + Here are some general resources about sr.ht as a whole. # Billing diff --git a/todo.sr.ht/index.md b/todo.sr.ht/index.md index b3f73df..7d105be 100644 --- a/todo.sr.ht/index.md +++ b/todo.sr.ht/index.md @@ -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. diff --git a/tutorials/builds.sr.ht/github-integration.md b/tutorials/builds.sr.ht/github-integration.md index 696eeb3..54b42ec 100644 --- a/tutorials/builds.sr.ht/github-integration.md +++ b/tutorials/builds.sr.ht/github-integration.md @@ -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 diff --git a/tutorials/builds.sr.ht/index.html b/tutorials/builds.sr.ht/index.html index e09b40a..8725e70 100644 --- a/tutorials/builds.sr.ht/index.html +++ b/tutorials/builds.sr.ht/index.html @@ -1,3 +1,7 @@ +--- +title: builds.sr.ht tutorials +--- +

Ready to do more with builds.sr.ht? Here is a collection of useful tutorials for setting up various kinds of build automations. diff --git a/tutorials/builds.sr.ht/using-build-secrets.md b/tutorials/builds.sr.ht/using-build-secrets.md index 34a178f..c816573 100644 --- a/tutorials/builds.sr.ht/using-build-secrets.md +++ b/tutorials/builds.sr.ht/using-build-secrets.md @@ -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 diff --git a/tutorials/getting-started-with-builds.md b/tutorials/getting-started-with-builds.md index c8d5489..54ad0d5 100644 --- a/tutorials/getting-started-with-builds.md +++ b/tutorials/getting-started-with-builds.md @@ -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 diff --git a/tutorials/set-up-account-and-git.md b/tutorials/set-up-account-and-git.md index 1c875a2..4a0d75f 100644 --- a/tutorials/set-up-account-and-git.md +++ b/tutorials/set-up-account-and-git.md @@ -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.