scottk/firezone
1
0
Fork 0
mirror of https://github.com/outbackdingo/firezone.git synced 2026-03-22 05:41:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #413 from firezone/backlog/186/more-docs-content

Browse Source 
Fix docs linter
This commit is contained in:
Jamil
2022-01-23 20:57:50 -08:00
committed by GitHub
parent 577824dbe3 5a73dcd11a
commit fa7fbb1707
3 changed files with 13 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
.github/workflows/ci.yml vendored
View File

@@ -13,15 +13,15 @@ defaults:
jobs:
lint-docs:
runs-on: macos-11
steps:
- uses: actions/checkout@v2
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version: '14.18.2'
- name: Lint Docs
run: |
npm install -g markdownlint-cli
markdownlint docs/
- name: Lint Docs
run: |
npm install -g markdownlint-cli
markdownlint docs/
static-analysis:
runs-on: ubuntu-18.04
@@ -121,7 +121,10 @@ jobs:
mix coveralls.github --umbrella || mix test
build-package-test:
needs: unit-test
needs:
- static-analysis
- unit-test
- lint-docs
runs-on: ${{ matrix.os }}
strategy:
# Failing fast breaks the Omnibus build cache because the job is

1
docs/docs/deploy/server.md
View File

@@ -10,7 +10,6 @@ parent: Deploy
[prerequisites]({% link docs/deploy/prerequisites.md %}) before following this
guide.
## Installation Instructions
**NOTE**: Firezone modifies the kernel netfilter and routing tables. Other

6
docs/docs/reference/configuration-file.md
View File

@@ -9,12 +9,12 @@ parent: Reference
Shown below is a complete listing of the configuration options available in
`/etc/firezone/firezone.rb`.
<!-- markdownlint-disable MD043 -->
<!-- markdownlint-disable MD013 -->
| option | description | default value |
| ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------- |
| `default['firezone']['nginx']['enabled']` | Whether to enable the bundled nginx server. | `true` |
| `default['firezone']['fqdn']` | FQDN of this Firezone instance. | `(node['fqdn'] \|\| node['hostname']).downcase` |
| `default['firezone']['fqdn']` | FQDN of this Firezone instance. | `(node['fqdn'] || node['hostname']).downcase` |
| `default['firezone']['config_directory']` | Top-level directory for Firezone configuration. | `'/etc/firezone'` |
| `default['firezone']['install_directory']` | Top-level directory to install Firezone to. | `'/opt/firezone'` |
| `default['firezone']['app_directory']` | Top-level directory to install the Firezone web application. | `"#{node['firezone']['install_directory']}/embedded/service/firezone"` |
@@ -146,4 +146,4 @@ Shown below is a complete listing of the configuration options available in
| `default['firezone']['connectivity_checks']['enabled']` | Enable or disable the Firezone connectivity checks service. | `true` |
| `default['firezone']['connectivity_checks']['interval']` | Interval between connectivity checks in seconds. | `3_600` |
<!-- markdownlint-enable MD043 -->
<!-- markdownlint-enable MD013 -->