diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..afa2173 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,21 @@ +name: Documentation + +on: + schedule: + - cron: '0 0 * * 0' # At 00:00 every Sunday + push: + branches: [ master ] + pull_request: + branches: [ master ] + +jobs: + + markdown-check: + name: Check Markdown + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + - uses: gaurav-nelson/github-action-markdown-link-check@v1 + with: + config-file: .github/workflows/mlc_config.json diff --git a/.github/workflows/mlc_config.json b/.github/workflows/mlc_config.json new file mode 100644 index 0000000..6b37a94 --- /dev/null +++ b/.github/workflows/mlc_config.json @@ -0,0 +1,5 @@ +{ + "ignorePatterns": [ + { "pattern": "^http:\/\/localhost:" } + ] +} diff --git a/README.md b/README.md index da80320..8fb8533 100644 --- a/README.md +++ b/README.md @@ -280,7 +280,7 @@ The Kibana default configuration is stored in [`kibana/config/kibana.yml`][confi It is also possible to map the entire `config` directory instead of a single file. Please refer to the following documentation page for more details about how to configure Kibana inside Docker -containers: [Running Kibana on Docker][kbn-docker]. +containers: [Install Kibana with Docker][kbn-docker]. ### How to configure Logstash diff --git a/extensions/apm-server/README.md b/extensions/apm-server/README.md index cddad91..c1178b5 100644 --- a/extensions/apm-server/README.md +++ b/extensions/apm-server/README.md @@ -38,8 +38,7 @@ app.config['ELASTIC_APM'] = { } ``` -More configuration settings can be found for each language in the following documentation page: [Install APM -agents][apm-agents]. +Configuration settings for each supported language are available in the APM documentation: [APM Agents][apm-agents]. ## Checking connectivity and importing default APM dashboards @@ -54,5 +53,5 @@ agents][apm-agents]. [Running APM Server on Docker][apm-docker] -[apm-agents]: https://www.elastic.co/guide/en/apm/get-started/current/agents.html +[apm-agents]: https://www.elastic.co/guide/en/apm/get-started/current/components.html#_apm_agents [apm-docker]: https://www.elastic.co/guide/en/apm/server/current/running-on-docker.html