Skip to content

Commit

Permalink
feat: check markdown links
Browse files Browse the repository at this point in the history
  • Loading branch information
@vscaiceanu-1a
vscaiceanu-1a committed Oct 26, 2023
1 parent 2075b38 commit 9a2dc47
Show file tree
Hide file tree
Showing 7 changed files with 41 additions and 7 deletions.
19 changes: 19 additions & 0 deletions .github/workflows/check-md.yml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: Check Markdown links

on:
pull_request:
branches:
- main
- 'release/*'

jobs:
markdown-link-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
config-file: '.github/workflows/markdown.links.config.json'
check-modified-files-only: 'no' # TODO: set to 'yes' before merging
use-verbose-mode: 'yes'
use-quiet-mode: 'yes'
15 changes: 15 additions & 0 deletions .github/workflows/markdown.links.config.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"ignorePatterns": [
{
"pattern": "^https://dummy-website.com"
}
],
"httpHeaders": [
{
"urls": ["https://github.com/", "https://guides.github.com/", "https://help.github.com/", "https://docs.github.com/"],
"headers": {
"Accept-Encoding": "zstd, br, gzip, deflate"
}
}
]
}
6 changes: 3 additions & 3 deletions docs/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The documentation is sorted by topic but in the table below, you shall find the
| @o3r/extractors | Utilities to extract your application metadata to interact with your CMS | @o3r/core <br/> @o3r/dev-tools | |
| @o3r/forms | Utilities to enhance angular form (asynchronous decorator, additional validator, error store...) | @o3r/core <br/> @o3r/dev-tools | [README](./forms/README.md) <br/> [FORM_ERRORS](./forms/FORM_ERRORS.md) <br/> [FORM_STRUCTURE](./forms/FORM_STRUCTURE.md) <br/> [FORM_SUBMIT_AND_INTERCOMMUNICATION](./forms/FORM_SUBMIT_AND_INTERCOMMUNICATION.md) <br/> [FORM_VALIDATION](./forms/FORM_VALIDATION.md) |
| @o3r/localization | Provide a fallback language/translation support and debug tools | @o3r/core <br/> @o3r/dev-tools | [LOCALIZATION](./localization/LOCALIZATION.md) <br/> [CMS_ADAPTERS](./cms-adapters/CMS_ADAPTERS.md) |
| @o3r/logger | Bridge to target different logger (logrocket, fullstory, smartlook) with a common interface | N/A | [LOGS](./logger/LOGS.md) |
| @o3r/logger | Bridge to target different logger (logrocket, fullstory, smartlook) with a common interface | N/A | [LOGS](./logger/LOGS.md) |
| @o3r/mobile | Helpers and store to integrate Capacitor into your Otter application. <br/> Integration with the pCloudy API for e2e testing on real devices. | @o3r/core <br/> @o3r/logger | |
| @o3r/routing | Module to configure an Otter application's routing (POST parameter management, preloading strategy, guard recommendation) | @o3r/core <br/> @o3r/dev-tools | [REQUEST_PARAMETERS_SERVICE](./routing/REQUEST_PARAMETERS_SERVICE.md) <br/> [ROUTING](./routing/ROUTING.md) <br/> [APP_SERVER_ROUTING](./routing/APP_SERVER_ROUTING.md) |
| @o3r/rules-engine | Rule engine executed on your Otter application to customize your application translations, placeholders and configs based on a json file generated by your CMS | @o3r/components <br/> @o3r/configuration <br/> @o3r/core <br/> @o3r/dev-tools <br/> @o3r/dynamic-content <br/> @o3r/extractors <br/> @o3r/localization <br/> @o3r/logger <br/> @o3r/styling | [how-it-works](./rules-engine/how-it-works.md) <br/> [how-to-use](./rules-engine/how-to-use.md) <br/> [examples](./rules-engine/examples.md) <br/> [facts](./rules-engine/facts.md) <br/> [operators](./rules-engine/operators.md) <br/> [rule](./rules-engine/rule.md) <br/> [ruleset](./rules-engine/ruleset.md) <br/> [CMS_ADAPTERS](./cms-adapters/CMS_ADAPTERS.md) |
Expand All @@ -28,5 +28,5 @@ The documentation is sorted by topic but in the table below, you shall find the
| @o3r/styling | Styling framework to apply a theme on an Otter application at build time and runtime to support CMS customization | @o3r/core <br/> @o3r/dynamic-content <br/> @o3r/extractors <br/> @o3r/schematics | [THEME](./styling/THEME.md) <br/> [TYPOGRAPHY](./styling/TYPOGRAPHY.md) <br/> [CMS_ADAPTERS](./cms-adapters/CMS_ADAPTERS.md) |
| @o3r/testing | Testing (e2e, unit test) utilities to help you build your own E2E pipeline integrating visual testing | @o3r/localization <br/> @o3r/schematics | [POST_MESSAGE_INTERCEPTOR](./testing/POST_MESSAGE_INTERCEPTOR.md) <br/> [UNIT_TESTS_SETUP](./testing/UNIT_TESTS_SETUP.md) |
| @o3r/third-party | Bridge to communicate with third parties via an iFrame solution | N/A | [A/B Testing](./ab-testing/AB_TESTING.md) |
| @o3r/vscode-extension | Various in house VSCode extensions to help you with the development of your Otter application with this IDE (automated generated Otter components etc.) | N/A | [vscode-extension](./vscode-extension.md) |
| @o3r/eslint-config-otter | Recommended eslint configuration for Otter project | @o3r/eslint-plugin | [eslint-config](./linter/eslint-config.md) |
| @o3r/vscode-extension | Various in house VSCode extensions to help you with the development of your Otter application with this IDE (automated generated Otter components etc.) | N/A | [vscode-extension](../apps/vscode-extension/README.md) |
| @o3r/eslint-config-otter | Recommended eslint configuration for Otter project | @o3r/eslint-plugin | [eslint-config](./linter/eslint-config.md) |
2 changes: 1 addition & 1 deletion docs/rules-engine/how-to-use/performance-metrics.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The marks names are formatted as following:
## Performance reporting API configuration

By default, if the rules engine is running in a browser, the performance metrics are reported via the [Performance Timeline API](https://developer.mozilla.org/en-US/docs/Web/API/Performance_Timeline). If the rules engine is running in a Node, there is no default performance reporting mechanism.
By default, if the rules engine is running in a browser, the performance metrics are reported via the [Performance API](https://developer.mozilla.org/en-US/docs/Web/API/Performance_API). If the rules engine is running in a Node, there is no default performance reporting mechanism.

The reporting of the performance metrics can be configured via the rules engine `performance` option.
The following example shows how to configure the reporting of the performance metrics in a Node application context :
Expand Down
2 changes: 1 addition & 1 deletion tools/github-actions/download-build-output/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Download and restore the `dist` folders from GitHub artifact (check [Upload build output](../upload-build-output/readme.md))

## Task options
See [Action specifications](tools/github-actions/download-build-output/action.yml) directly for more information about the supported parameters.
See [Action specifications](./action.yml) directly for more information about the supported parameters.

## Usage example
```yaml
Expand Down
2 changes: 1 addition & 1 deletion tools/github-actions/setup/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Including :

## Task options

See [Action specifications](tools/github-actions/setup/action.yml) directly for more information about the supported parameters.
See [Action specifications](./action.yml) directly for more information about the supported parameters.

## Usage example

Expand Down
2 changes: 1 addition & 1 deletion tools/github-actions/upload-build-output/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ You can then use the download build output action for the download (check [Downl

## Task options

See [Action specifications](tools/github-actions/upload-build-output/action.yml) directly for more information about the supported parameters.
See [Action specifications](./action.yml) directly for more information about the supported parameters.

## Usage example

Expand Down

0 comments on commit 9a2dc47

Please sign in to comment.