Fix markdown documentation links (#35)

- Update/remove broken links
- Add appropriate ignore rules for example URLs and osquery site
This commit is contained in:
Zach Wasserman 2020-11-12 19:06:06 -08:00 committed by GitHub
parent ebd355c52c
commit 138329c371
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 22 additions and 5 deletions

View File

@ -8,3 +8,6 @@ jobs:
steps: steps:
- uses: actions/checkout@master - uses: actions/checkout@master
- uses: gaurav-nelson/github-action-markdown-link-check@v1 - uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
use-quiet-mode: 'yes'
config-file: .github/workflows/markdown-link-check-config.json

View File

@ -0,0 +1,14 @@
{
"ignorePatterns": [
{
"localhost": "localhost",
"osquery-downloads": "osquery.io/downloads",
"fleet.acme.org": "fleet.acme.org",
"fleet.corp.example.com": "fleet.corp.example.com"
}
],
"retryOn429": true,
"retryCount": 2,
"fallbackRetryDelay": "2s",
"aliveStatusCodes": [200, 206]
}

View File

@ -331,7 +331,7 @@ spec:
### Upgrade Plan ### Upgrade Plan
* Managing osquery options via the UI has been removed in favor of the more flexible solution provided by the CLI. If you have customized your osquery options with Fleet, there is [a database migration](server/datastore/mysql/migrations/data/20171212182458_MigrateOsqueryOptions.go) which will port your existing data into the new format when you run `fleet prepare db`. To download your osquery options after migrating your database, run `fleetctl get options > options.yaml`. Further modifications to your options should occur in this file and it should be applied with `fleetctl apply -f ./options.yaml`. * Managing osquery options via the UI has been removed in favor of the more flexible solution provided by the CLI. If you have customized your osquery options with Fleet, there is [a database migration](./server/datastore/mysql/migrations/data/20171212182458_MigrateOsqueryOptions.go) which will port your existing data into the new format when you run `fleet prepare db`. To download your osquery options after migrating your database, run `fleetctl get options > options.yaml`. Further modifications to your options should occur in this file and it should be applied with `fleetctl apply -f ./options.yaml`.
## Kolide Fleet 1.0.8 (May 3, 2018) ## Kolide Fleet 1.0.8 (May 3, 2018)

View File

@ -1,7 +1,7 @@
Releasing Fleet Releasing Fleet
=============== ===============
1. Update the [CHANGELOG](/CHANGELOG.md) with the changes that have been made since the last Fleet release. 1. Update the [CHANGELOG](../../CHANGELOG.md) with the changes that have been made since the last Fleet release.
2. Tag and push the new release in Git: 2. Tag and push the new release in Git:

View File

@ -201,4 +201,4 @@ sudo /usr/bin/osqueryd \
--logger_tls_period=10 --logger_tls_period=10
``` ```
If you go back to [https://localhost:8080/hosts/manage](https://localhost:8080/hosts/manage), you should have a host successfully enrolled in Fleet! For information on how to further use the Fleet application, see the [Application Documentation](../application/README.md). If you go back to [https://localhost:8080/hosts/manage](https://localhost:8080/hosts/manage), you should have a host successfully enrolled in Fleet!

View File

@ -171,4 +171,4 @@ sudo /usr/bin/osqueryd \
--logger_tls_period=10 --logger_tls_period=10
``` ```
If you go back to [https://localhost:8080/hosts/manage](https://localhost:8080/hosts/manage), you should have a host successfully enrolled in Fleet! For information on how to further use the Fleet application, see the [Application Documentation](../application/README.md). If you go back to [https://localhost:8080/hosts/manage](https://localhost:8080/hosts/manage), you should have a host successfully enrolled in Fleet!

View File

@ -5,7 +5,7 @@ The Fleet front-end is a Single Page Application using React and Redux.
## Running the Fleet web app ## Running the Fleet web app
For details instruction on building and serving the Fleet web application For details instruction on building and serving the Fleet web application
consult the [Development Documentation](./development/README.md) consult the [Development Documentation](../development/README.md)
## Directory Structure ## Directory Structure