docs: workflow and linter improvements #3805
Merged
+63
−39
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
…cing.md' -> '../../../architecture/adr-001-coin-source-tracing.md'
…ures as an example
This was referenced Jun 22, 2023
Closed
charleenfei
reviewed
Jun 29, 2023
crodriguezvega
requested review from
colin-axner,
AdityaSripal,
crodriguezvega,
damiannolan,
chatton and
DimitrisJim
as code owners
# Conflicts: # CHANGELOG.md # docs/.vuepress/config.js # docs/docs/01-ibc/09-roadmap.md # docs/docs/05-migrations/10-v7-to-v8.md # docs/versions
…3-docs-linters-and-workflows # Conflicts: # .github/workflows/link-check.yml # .markdownlint.jsonc # .markdownlintignore # scripts/linting/lint-changed-md-files.sh
crodriguezvega
approved these changes
Jul 4, 2023
There was a problem hiding this comment.
Looks good, @srdtrk! I left a couple of questions. And I pushed couple of md files that were listed when I run the makefile command.
| @@ -138,16 +138,6 @@ go.sum: go.mod | |||
| ### Documentation ### | |||
| ############################################################################### | |||
|
|
|||
| update-swagger-docs: statik | |||
|
|
||
| docs-lint-changed: | ||
| ./scripts/linting/lint-changed-md-files.sh | ||
| docs-link-check: |
There was a problem hiding this comment.
To be able to run this we need to have markdown-link-check installed, right?
charleenfei
approved these changes
Jul 5, 2023
Co-authored-by: Charly <[email protected]>
srdtrk
added a commit
that referenced
this pull request
Sep 20, 2023
* docs: migrate to docusaurus (#3511) The following stack was used: - Docusaurus 2 - tailwindcss - postcss Min required node version is: 16.14 --------- Co-authored-by: colin axnér <[email protected]> * merge: fixing conficts * merge: bringing back client docs * merge: removing versions again * merge: fix conflicts * fix: merge conflicts * fix: merge conflicts * fix: merge conflicts * docs: implement versioned documentation (#3577) * docs: workflow and linter improvements (#3805) * docs: added version 7.0.0 docs, need to check for bugs * docs: renamed the version to v7.0.0 * docs: added v6.1.0 * docs: added v5.3.0 * docs: added v4.4.0 * docs: updated the base url redirect, and version banners * docs: replaced 'Pre-requisites Readings' -> 'Pre-requisite readings' * docs: added missing ADRs to README.md * docs: added versioning info to README.md * docs: replaced '../../../../docs/architecture/adr-001-coin-source-tracing.md' -> '../../../architecture/adr-001-coin-source-tracing.md' * docs: updated the url of the 7.0.0 (latest) * docs: fixed all broken links * docs: updated 'make build-docs' command to use docusaurus * docs: Added a Links section to README.md * docs: updated code blocks in 02-integration.md to use docusaurus features as an example * docs: removed all TODOs from README.md * docs: updated the typical versioned docs tree in README.md * docs: made file naming section more precise * docs: updated README.md * docs: updated release-tracker.md * docs: removed search section from README.md * docs: updated release-management.md * docs: updated Makefile * docs: fixed more broken links * docs: updated workflows to only run when changes to main occur (not releases) * fix(ci): attempt to convert absolute urls to absolute filepaths in the ci * fix(ci): added '@site/' to ignorePatterns instead * imp(docs): removed wrong comment * fix(ci): fix markdown-link-check for docusaurus * docs: changed architecture links to absolute links * fix(ci): replace only affects architect and event links now * docs: fix broken more links * imp(ci): ignore http links in markdown-link-check replace statements * imp(ci): markdown-link-check should only run on modified md files * fix(ci): attempt to fix markdown-link-check * fix(ci): only check modified files for markdown-link-check * revert(ci): reverted link-check.yml to initial state * imp(ci): set link check timeout to 16 mins * imp(ci/link-check): link-check should ignore versioned_docs now * fix(ci/link-check): attempt to ignore files ending with '/' * docs: fixed broken link * docs: fixed broken link in RELEASES.md * fix(ci/link-check): config works now * refactor(ci/link-check): combined two regexp patterns into one in link-check config * fix(ci/link-check): config is good - attempt to fix the workflow * fix(ci/link-check): config is good - attempt to fix the workflow * fix(ci/link-check): added verbose mode * revert(ci/link-check): reverted workflow to initial state (not config) * nit: broke a link to test ci * revert(docs): fixed broken link * build(docs/deps): updated docusaurus to 2.4.1 * docs: replaced intro titles * docs: remove extra ')' * docs: wrapped some prerequisites in note * docs: replaces '::: tip' with ':::tip' * docs: replace '::: warning' with ':::warning' * docs: fix styling error * docs: readme updated * docs: removed all references to 'order:' frontmatter * docs: fixed list styling in transfer/state-transitions * docs: removed unneeded quotation * imp(docs): improved the markdownlint settings * imp(docs): improved the markdownlint settings * docs: ran markdownlint with the new config * docs: do not lint autogenerated CHANGELOG.md * docs: removed 'bash' from the codeblock in the PR template * docs: added '.github' to .markdownlintignore * imp(docs): added more comments to markdownlint config * docs: fixed incorrect category linking * docs: fixed indentation issue in fee middleware * imp(docs): added two more rules to markdownlint * docs: ran 'make docs-lint' * docs: made transfer the first app * docs: made transfer the first app in all versions * imp(makefile/docs): added link-check to makefile * docs: added back the spaces * docs: fixed a lint violation * docs: contents of DOCS_GUIDELINES.md have been merged with README.md * docs: ran markdownlint-cli * docs: fixed a lot of linting errors * docs: fixed a more linting errors * docs: fixed all linting errors * docs: corrected PR template's code box * imp(docs): add a new workflow for linting changed markdown files * docs: fixed linter violation * imp(docs): switch to using markdownlint-cli2 * revert(ci/markdown-lint): original state * imp(ci/markdown-lint): fix an error * imp(ci/markdown-lint): only runs on PRs which modify .md files * imp(ci/markdown-lint): only runs on PRs which modify .md files not in .github * docs: fixed broken link * imp(ci/link-check): this workflow only runs if a .md file has been modified * deps(docs): ran 'npm i --save @easyops-cn/docusaurus-search-local' * feat(docs): added local search bar * fix(docs): search bar highlight color is not buggy anymore * imp(docs): added term highlighting to search * fix: merge conflicts * docs: ran linter * refactor: removed markdownlint changes in this PR * refactor: removed markdownlint changes in this PR * refactor: removed linkcheck changes in this PR * revert: changes in PR template * revert: added swagger-docs thing back * revert: "revert: added swagger-docs thing back" This reverts commit f6cdcdb. * revert: "revert: changes in PR template" This reverts commit 5a23809. * revert: "refactor: removed linkcheck changes in this PR" This reverts commit b401b31. * revert: "refactor: removed markdownlint changes in this PR" This reverts commit eb31283. * revert: "refactor: removed markdownlint changes in this PR" This reverts commit d5b74e0. * add extra path to ignore * docs linting * Update docs/docs/01-ibc/09-roadmap.md Co-authored-by: Charly <[email protected]> --------- Co-authored-by: Carlos Rodriguez <[email protected]> Co-authored-by: Charly <[email protected]> * feat: v7.3.x docs added * imp: improved Makefile for serving docs * imp: checked out some problematic files * fix: merge conflicts * imp(docs): added versioned docs for v6.2.x * ci: switched to docusaurus check and deploy workflows (#4688) * ci: switched to docusaurus check and deploy workflows * ci: added workflow_dispatch back to deploy-docs * imp(lint): ignores all changelogs now * imp: ran linter * imp(makefile): improved build-docs * fix(docs): broken links * imp: improved workflows around markdownlint * imp: improved workflows around markdownlint * imp(docs): added the new ibc assets * deps(docs): updated deps * style(docs): reorganized footer code * docs: fix cosmos-sdk broken links * imp(docs): removed link from the footer logo * imp(docs): improved footer * imp(docs): added a link to privacy policy * deps(docs): added 'npm run dev' script * imp(docs): apply review item * imp: ran 'make docs-lint' * imp: added 'make tag-docs-version' --------- Co-authored-by: colin axnér <[email protected]> Co-authored-by: Carlos Rodriguez <[email protected]> Co-authored-by: Charly <[email protected]>
3 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.
Description
link-checkworkflow is now only activated upon.mdfile modifications. (excluding.github/directory)~~markdown-lintworkflow has been addedmarkdownlinttomarkdownlint-cli2in this repo. (Makefile is updated accordingly).mdfile has been modified (not including.github/directory)..markdownlint-cli2.jsonc, this tool also continues to use.markdownlint.jsonc.markdownlint.jsoncto address: Consider using a linter for markdown files #3543.closes: #3543
Draft PR to Open PR Requirements
Commit Message / Changelog Entry
see the guidelines for commit messages. (view raw markdown for examples)
Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.
docs/) or specification (x/<module>/spec/).godoccomments.Files changedin the Github PR explorer.Codecov Reportin the comment section below once CI passes.