forked from thanos-io/thanos
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Add
mdox remote/local link checking and move web preprocess (t…
…hanos-io#4357) * Add mdox remote and local link checking Signed-off-by: Saswata Mukherjee <[email protected]> * Add mdox transform Signed-off-by: Saswata Mukherjee <[email protected]> * Update mdox and config Signed-off-by: Saswata Mukherjee <[email protected]> * Make YAML DRY & fix prev-release Signed-off-by: Saswata Mukherjee <[email protected]> * Localize tip links; Switch to Origin.Path Signed-off-by: Saswata Mukherjee <[email protected]>
- Loading branch information
1 parent
7a8d189
commit 9d6b004
Showing
62 changed files
with
375 additions
and
414 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| version: 1 | ||
|
|
||
| inputDir: "$(OUTPUT_CONTENT_DIR)/$(tags)-git-docs" | ||
| outputDir: "$(OUTPUT_CONTENT_DIR)/$(tags)" | ||
| extraInputGlobs: | ||
| - "CHANGELOG.md" | ||
| - "SECURITY.md" | ||
| - "MAINTAINERS.md" | ||
| - "CONTRIBUTING.md" | ||
| - "CODE_OF_CONDUCT.md" | ||
|
|
||
| gitIgnored: true | ||
| localLinksStyle: | ||
| hugo: | ||
| indexFileName: "_index.md" | ||
|
|
||
| transformations: | ||
|
|
||
| - glob: "../../../CHANGELOG.md" | ||
| path: /thanos/CHANGELOG.md | ||
| frontMatter: | ||
| template: | | ||
| title: Changelog | ||
| type: docs | ||
| menu: thanos | ||
| lastmod: "{{ .Origin.LastMod }}" | ||
| - glob: "../../../MAINTAINERS.md" | ||
| path: /thanos/MAINTAINERS.md | ||
| frontMatter: | ||
| template: | | ||
| title: Maintainers | ||
| type: docs | ||
| menu: thanos | ||
| lastmod: "{{ .Origin.LastMod }}" | ||
| - glob: "../../../SECURITY.md" | ||
| path: /thanos/SECURITY.md | ||
| frontMatter: | ||
| template: | | ||
| title: Security | ||
| type: docs | ||
| menu: thanos | ||
| lastmod: "{{ .Origin.LastMod }}" | ||
| - glob: "../../../CODE_OF_CONDUCT.md" | ||
| path: /contributing/CODE_OF_CONDUCT.md | ||
| frontMatter: | ||
| template: | | ||
| title: Code of Conduct | ||
| type: docs | ||
| menu: contributing | ||
| lastmod: "{{ .Origin.LastMod }}" | ||
| - glob: "../../../CONTRIBUTING.md" | ||
| path: /contributing/CONTRIBUTING.md | ||
| frontMatter: | ||
| template: | | ||
| title: Contributing | ||
| type: docs | ||
| menu: contributing | ||
| lastmod: "{{ .Origin.LastMod }}" | ||
| - glob: "*.md" | ||
| path: /thanos/* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| version: 1 | ||
|
|
||
| validators: | ||
| # Validators to skip checking PR/issue links of Thanos, Prometheus and Cortex. | ||
| - regex: '(^http[s]?:\/\/)(www\.)?(github\.com\/)thanos-io\/thanos(\/pull\/|\/issues\/)' | ||
| type: 'githubPullsIssues' | ||
| - regex: '(^http[s]?:\/\/)(www\.)?(github\.com\/)prometheus\/prometheus(\/pull\/|\/issues\/)' | ||
| type: 'githubPullsIssues' | ||
| - regex: '(^http[s]?:\/\/)(www\.)?(github\.com\/)cortexproject\/cortex(\/pull\/|\/issues\/)' | ||
| type: 'githubPullsIssues' | ||
| # Ignore Thanos release links. | ||
| - regex: '(^http[s]?:\/\/)(www\.)?(github\.com\/)thanos-io\/thanos(\/releases\/)' | ||
| type: 'ignore' | ||
| # Causes http stream errors with statuscode 0 sometimes. But is safe to skip. | ||
| - regex: 'slack\.cncf\.io' | ||
| type: 'ignore' | ||
| # 301 errors even when curl-ed. | ||
| - regex: 'envoyproxy\.io' | ||
| type: 'ignore' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,146 @@ | ||
| version: 1 | ||
|
|
||
| inputDir: "docs" | ||
| outputDir: "website/docs-pre-processed/tip" | ||
| extraInputGlobs: | ||
| - "CHANGELOG.md" | ||
| - "SECURITY.md" | ||
| - "MAINTAINERS.md" | ||
| - "CONTRIBUTING.md" | ||
| - "CODE_OF_CONDUCT.md" | ||
|
|
||
| gitIgnored: true | ||
| localLinksStyle: | ||
| hugo: | ||
| indexFileName: "_index.md" | ||
|
|
||
| transformations: | ||
|
|
||
| - glob: "../CHANGELOG.md" | ||
| path: /thanos/CHANGELOG.md | ||
| frontMatter: | ||
| template: | | ||
| title: Changelog | ||
| type: docs | ||
| menu: thanos | ||
| lastmod: "{{ .Origin.LastMod }}" | ||
| backMatter: &docBackMatter | ||
| template: | | ||
| Found a typo, inconsistency or missing information in our docs? | ||
| Help us to improve [Thanos](https://thanos.io) documentation by proposing a fix [on GitHub here](https://github.com/thanos-io/thanos/edit/main/{{ .Origin.Path }}) :heart: | ||
| - glob: "../MAINTAINERS.md" | ||
| path: /thanos/MAINTAINERS.md | ||
| frontMatter: | ||
| template: | | ||
| title: Maintainers | ||
| type: docs | ||
| menu: thanos | ||
| lastmod: "{{ .Origin.LastMod }}" | ||
| backMatter: *docBackMatter | ||
|
|
||
| - glob: "../SECURITY.md" | ||
| path: /thanos/SECURITY.md | ||
| frontMatter: | ||
| template: | | ||
| title: Security | ||
| type: docs | ||
| menu: thanos | ||
| lastmod: "{{ .Origin.LastMod }}" | ||
| backMatter: *docBackMatter | ||
|
|
||
| - glob: "../CODE_OF_CONDUCT.md" | ||
| path: /contributing/CODE_OF_CONDUCT.md | ||
| frontMatter: | ||
| template: | | ||
| title: Code of Conduct | ||
| type: docs | ||
| menu: contributing | ||
| lastmod: "{{ .Origin.LastMod }}" | ||
| backMatter: *docBackMatter | ||
|
|
||
| - glob: "../CONTRIBUTING.md" | ||
| path: /contributing/CONTRIBUTING.md | ||
| frontMatter: | ||
| template: | | ||
| title: Contributing | ||
| type: docs | ||
| menu: contributing | ||
| lastmod: "{{ .Origin.LastMod }}" | ||
| backMatter: *docBackMatter | ||
|
|
||
| - glob: "**/README.md" | ||
| path: _index.md | ||
| frontMatter: &justTitleFrontMatter | ||
| template: | | ||
| title: "{{ .Origin.FirstHeader }}" | ||
| backMatter: *docBackMatter | ||
|
|
||
| - glob: "getting-started.md" | ||
| path: /thanos/getting-started.md | ||
| popHeader: false | ||
| frontMatter: &weightOneFrontMatter | ||
| template: | | ||
| type: docs | ||
| title: "{{ .Origin.FirstHeader }}" | ||
| menu: thanos | ||
| weight: 1 | ||
| lastmod: "{{ .Origin.LastMod }}" | ||
| backMatter: *docBackMatter | ||
|
|
||
| - glob: "quick-tutorial.md" | ||
| path: /thanos/quick-tutorial.md | ||
| popHeader: false | ||
| frontMatter: *weightOneFrontMatter | ||
| backMatter: *docBackMatter | ||
|
|
||
| - glob: "proposals-*/README.md" | ||
| path: /proposals-*/_index.md | ||
| frontMatter: *justTitleFrontMatter | ||
| backMatter: *docBackMatter | ||
|
|
||
| - glob: "README.md" | ||
| path: /thanos/_index.md | ||
| frontMatter: *justTitleFrontMatter | ||
| backMatter: *docBackMatter | ||
|
|
||
| - glob: "*.md" | ||
| path: /thanos/* | ||
| popHeader: false | ||
| frontMatter: | ||
| template: | | ||
| type: docs | ||
| title: "{{ .Origin.FirstHeader }}" | ||
| menu: thanos | ||
| lastmod: "{{ .Origin.LastMod }}" | ||
| backMatter: *docBackMatter | ||
|
|
||
| - glob: "operating/*.md" | ||
| path: /operating/* | ||
| frontMatter: | ||
| template: | | ||
| type: docs | ||
| title: "{{ .Origin.FirstHeader }}" | ||
| menu: operating | ||
| lastmod: "{{ .Origin.LastMod }}" | ||
| backMatter: *docBackMatter | ||
|
|
||
| - glob: "contributing/*.md" | ||
| path: /contributing/* | ||
| frontMatter: | ||
| template: | | ||
| type: docs | ||
| title: "{{ .Origin.FirstHeader }}" | ||
| menu: contributing | ||
| lastmod: "{{ .Origin.LastMod }}" | ||
| backMatter: *docBackMatter | ||
|
|
||
| - glob: "components/*.md" | ||
| path: /components/* | ||
| frontMatter: | ||
| template: | | ||
| type: docs | ||
| title: "{{ .Origin.FirstHeader }}" | ||
| menu: components | ||
| lastmod: "{{ .Origin.LastMod }}" | ||
| backMatter: *docBackMatter |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.