docs: Add mdox remote/local link checking and move web preprocess
#4357
Conversation
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
bwplotka
reviewed
Jun 22, 2021
saswatamcode
changed the title
mdox remote and local link checkingmdox remote/local link checking and move web preprocess
saswatamcode
force-pushed
the
mdox-links
branch
2 times, most recently
from
b14d745
to
5bcdee5
Compare
bwplotka
previously approved these changes
Jun 24, 2021
.mdox.validate.yaml
Outdated
|
|
||
| validators: | ||
| # Smart validators to skip checking PR/issue links of Thanos, Prometheus and Cortex. | ||
| - regex: 'thanos-io\/thanos' |
.mdox.validate.yaml
Outdated
| # 301 errors even when curl-ed. | ||
| - regex: 'envoyproxy\.io' | ||
| type: 'ignore' | ||
| # Due to rate limiting, mdox link checking is a time consuming process. |
.mdox.yaml
Outdated
Comment on lines
64
to
76
| - glob: "components/README.md" | ||
| path: /components/_index.md | ||
| frontMatter: | ||
| template: | | ||
| title: "{{ .Origin.FirstHeader }}" | ||
|
|
||
| - glob: "operating/README.md" | ||
| path: /operating/_index.md | ||
| frontMatter: | ||
| template: | | ||
| title: "{{ .Origin.FirstHeader }}" | ||
|
|
||
| - glob: "contributing/README.md" | ||
| path: /contributing/_index.md | ||
| frontMatter: | ||
| template: | | ||
| title: "{{ .Origin.FirstHeader }}" |
There was a problem hiding this comment.
I wonder if just one element will be enough:
Suggested change
| - glob: "components/README.md" | |
| path: /components/_index.md | |
| frontMatter: | |
| template: | | |
| title: "{{ .Origin.FirstHeader }}" | |
| - glob: "operating/README.md" | |
| path: /operating/_index.md | |
| frontMatter: | |
| template: | | |
| title: "{{ .Origin.FirstHeader }}" | |
| - glob: "contributing/README.md" | |
| path: /contributing/_index.md | |
| frontMatter: | |
| template: | | |
| title: "{{ .Origin.FirstHeader }}" | |
| - glob: "**/README.md" | |
| path: _index.md | |
| frontMatter: | |
| template: | | |
| title: "{{ .Origin.FirstHeader }}" |
bwplotka
reviewed
Jun 24, 2021
|
@saswatamcode I think we're ready to merge 🚀 just need to fix the CI docs check. You will be able to repro this failure locally by running |
|
Hi @ianbillett! This PR has few blockers such as this and merging right now will break the website for previous version docs. I'll be raising PRs soon to fix those in mdox and in previous Thanos release branches and update this PR as well! This can be merged then! 🤗 |
saswatamcode
force-pushed
the
mdox-links
branch
from
5bcdee5
to
dbf0bee
Compare
saswatamcode
changed the title
mdox remote/local link checking and move web preprocessmdox remote/local link checking and move web preprocess
bwplotka
changed the title
mdox remote/local link checking and move web preprocessmdox remote/local link checking and move web preprocess
bwplotka
previously approved these changes
Aug 3, 2021
.mdox.yaml
Outdated
| lastmod: "{{ .Origin.LastMod }}" | ||
| backMatter: | ||
| template: | | ||
| Found a typo, inconsistency or missing information in our docs? |
There was a problem hiding this comment.
We could try https://support.atlassian.com/bitbucket-cloud/docs/yaml-anchors/ (:
Signed-off-by: Saswata Mukherjee <saswataminsta@yahoo.com>
Signed-off-by: Saswata Mukherjee <saswataminsta@yahoo.com>
Signed-off-by: Saswata Mukherjee <saswataminsta@yahoo.com>
saswatamcode
force-pushed
the
mdox-links
branch
from
5214cc5
to
4442889
Compare
Signed-off-by: Saswata Mukherjee <saswataminsta@yahoo.com>
saswatamcode
force-pushed
the
mdox-links
branch
from
4442889
to
004ae26
Compare
This was referenced Aug 10, 2021
This was referenced Aug 10, 2021
saswatamcode
force-pushed
the
mdox-links
branch
from
1db45c4
to
c5ae260
Compare
Signed-off-by: Saswata Mukherjee <saswataminsta@yahoo.com>
saswatamcode
force-pushed
the
mdox-links
branch
from
c5ae260
to
5812b5b
Compare
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds
mdoxlocal and remote link checking with smart validation.cc: @bwplotka
Note: This fixes all links in docs. So while all links will work from GitHub now, website links may break. This will be fixed in subsequent PRs where current preprocess will be replaced by
mdox tranform.