docs: Fix 404 links (#1678)

Co-authored-by: scon.io <[email protected]> Co-authored-by: Aaron Dewes <[email protected]>
probot · Nov 14, 2023 · 76f3376 · 76f3376
1 parent c1f0767
commit 76f3376
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 10 deletions.
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -7,19 +7,19 @@ title: Configuration
 
 When developing a Probot App, you will need to have several different fields in a `.env` file which specify environment variables. Here are some common use cases:
 
-| Environment Variable                | [Programmatic Argument](/docs/development.md#run-probot-programmatically) | Description                                                                                                                                                                                                                                                                                                                                                                                                                                    |
+| Environment Variable                | [Programmatic Argument](/docs/development/#run-probot-programmatically) | Description                                                                                                                                                                                                                                                                                                                                                                                                                                    |
 | ----------------------------------- | ------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `APP_ID`                            | `new Probot({ appId })`                                                   | The App ID assigned to your GitHub App. **Required** <p>_(Example: `1234`)_</p>                                                                                                                                                                                                                                                                                                                                                                |
-| `PRIVATE_KEY` or `PRIVATE_KEY_PATH` | `new Probot({ privateKey })`                                              | The contents of the private key for your GitHub App. If you're unable to use multiline environment variables, use base64 encoding to convert the key to a single line string. See the [Deployment](deployment.md) docs for provider specific usage. When using the `PRIVATE_KEY_PATH` environment variable, set it to the path of the `.pem` file that you downloaded from your GitHub App registration. <p>_(Example: `path/to/key.pem`)_</p> |
+| `PRIVATE_KEY` or `PRIVATE_KEY_PATH` | `new Probot({ privateKey })`                                              | The contents of the private key for your GitHub App. If you're unable to use multiline environment variables, use base64 encoding to convert the key to a single line string. See the [Deployment](/docs/deployment) docs for provider specific usage. When using the `PRIVATE_KEY_PATH` environment variable, set it to the path of the `.pem` file that you downloaded from your GitHub App registration. <p>_(Example: `path/to/key.pem`)_</p> |
 | **Webhook options**                 |                                                                           |
 | `WEBHOOK_PROXY_URL`                 | `new Server({ webhookProxy })`                                            | Allows your local development environment to receive GitHub webhook events. Go to https://smee.io/new to get started. <p>_(Example: `https://smee.io/your-custom-url`)_</p>                                                                                                                                                                                                                                                                    |
 | `WEBHOOK_SECRET`                    | `new Probot({ secret })`                                                  | The webhook secret used when creating a GitHub App. 'development' is used as a default, but the value in `.env` needs to match the value configured in your App settings on GitHub. Note: GitHub marks this value as optional, but for optimal security it's required for Probot apps. **Required** <p>_(Example: `development`)_</p>                                                                                                          |
 
-For more on the set up of these items, check out [Configuring a GitHub App](/docs/development.md#configuring-a-github-app).
+For more on the set up of these items, check out [Configuring a GitHub App](/docs/development/#configuring-a-github-app).
 
 Some less common environment variables are:
 
-| Environment Variable  | [Programmatic Argument](/docs/development.md#run-probot-programmatically) | Description                                                                                                                                                                                                                                                                                                             |
+| Environment Variable  | [Programmatic Argument](/docs/development/#run-probot-programmatically) | Description                                                                                                                                                                                                                                                                                                             |
 | --------------------- | ------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `GHE_HOST`            | `new Probot({ Octokit: ProbotOctokit.defaults({ baseUrl }) })`            | The hostname of your GitHub Enterprise instance. <p>_(Example: `github.mycompany.com`)_</p>                                                                                                                                                                                                                             |
 | `GHE_PROTOCOL`        | `new Probot({ Octokit: ProbotOctokit.defaults({ baseUrl }) })`            | The protocol of your GitHub Enterprise instance. Defaults to HTTPS. Do not change unless you are certain. <p>_(Example: `https`)_</p>                                                                                                                                                                                   |

diff --git a/docs/deployment.md b/docs/deployment.md
@@ -123,7 +123,7 @@ Probot runs like [any other Node app](https://devcenter.heroku.com/articles/depl
 
 ### As serverless function
 
-When deploying your Probot app to a serverless/function environment, you don't need to worry about handling the http webhook requests coming from GitHub, the platform takes care of that. In many cases you can use [`createNodeMiddleware`](/docs/development.md#use-createNodeMiddleware) directly, e.g. for Vercel or Google Cloud Function.
+When deploying your Probot app to a serverless/function environment, you don't need to worry about handling the http webhook requests coming from GitHub, the platform takes care of that. In many cases you can use [`createNodeMiddleware`](/docs/development/#use-createNodeMiddleware) directly, e.g. for Vercel or Google Cloud Function.
 
 ```js
 const { Probot, createProbot } = require("probot");

diff --git a/docs/development.md b/docs/development.md
@@ -259,7 +259,7 @@ async function example() {
 }
 ```
 
-Using the `Probot` class directly is great for [writing tests](/docs/testing.md) for your Probot app function. It permits you to pass a custom logger to test for log output, disable throttling, request retries, and much more.
+Using the `Probot` class directly is great for [writing tests](/docs/testing) for your Probot app function. It permits you to pass a custom logger to test for log output, disable throttling, request retries, and much more.
 
 ### Use Probot's Octokit
 

diff --git a/docs/github-api.md b/docs/github-api.md
@@ -86,7 +86,7 @@ Check out the [GitHub GraphQL API docs](https://docs.github.com/en/graphql) to l
 
 ## Unauthenticated Events
 
-When [receiving webhook events](/docs/webhooks.md), `context.octokit` is _usually_ an authenticated client, but there are a few events that are exceptions:
+When [receiving webhook events](/docs/webhooks), `context.octokit` is _usually_ an authenticated client, but there are a few events that are exceptions:
 
 - [`installation.deleted` & `installation.suspend`](https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#installation) - The installation was _just_ deleted or suspended, so we can't authenticate as the installation.
 
@@ -102,7 +102,7 @@ If you want to run a Probot App against a GitHub Enterprise instance, you'll nee
 GHE_HOST=fake.github-enterprise.com
 ```
 
-When [using Probot programmatically](/docs/development.md#run-probot-programmatically), set the `baseUrl` option for the [`Probot`](https://probot.github.io/api/latest/classes/probot.Probot.html) constructor to the full base Url of the REST API
+When [using Probot programmatically](/docs/development/#run-probot-programmatically), set the `baseUrl` option for the [`Probot`](https://probot.github.io/api/latest/classes/probot.Probot.html) constructor to the full base Url of the REST API
 
 ```js
 const MyProbot = Probot.defaults({

diff --git a/docs/hello-world.md b/docs/hello-world.md
@@ -26,7 +26,7 @@ module.exports = (app) => {
 };
 ```
 
-The [`context`](https://probot.github.io/api/latest/classes/context.Context.html) passed to the event handler includes everything about the event that was triggered, as well as some helpful properties for doing something useful in response to the event. `context.octokit` is an authenticated GitHub client that can be used to [make REST API and GraphQL calls](/docs/github-api.md), and allows you to do almost anything programmatically that you can do through a web browser on GitHub.
+The [`context`](https://probot.github.io/api/latest/classes/context.Context.html) passed to the event handler includes everything about the event that was triggered, as well as some helpful properties for doing something useful in response to the event. `context.octokit` is an authenticated GitHub client that can be used to [make REST API and GraphQL calls](/docs/github-api), and allows you to do almost anything programmatically that you can do through a web browser on GitHub.
 
 Here is an example of an autoresponder app that comments on opened issues:
 

diff --git a/docs/http.md b/docs/http.md
@@ -5,7 +5,7 @@ title: HTTP routes
 
 # HTTP routes
 
-When starting your app using `probot run ./app.js` or using the [`Server`](/docs/development.md#use-server) class, your Probot app function will receive the `options.getRouter` function as its 2nd argument.
+When starting your app using `probot run ./app.js` or using the [`Server`](/docs/development/#use-server) class, your Probot app function will receive the `options.getRouter` function as its 2nd argument.
 
 Calling `getRouter('/my-app')` will return an [express](http://expressjs.com/) router that you can use to expose custom HTTP endpoints from your app.