Skip to content

Commit d39a825

Browse files
srdtrkcolin-axnercrodriguezvegacharleenfei
authoredSep 20, 2023
feat(docs): migrate docs to docusaurus (cosmos#4693)
* docs: migrate to docusaurus (cosmos#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 (cosmos#3577) * docs: workflow and linter improvements (cosmos#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 (cosmos#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]>

File tree

546 files changed

+40990
-19416
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

546 files changed

+40990
-19416
lines changed
 

‎.github/ISSUE_TEMPLATE/release-tracker.md

+14-10
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
---
22
name: Release tracker
33
about: Create an issue to track release progress
4-
54
---
65

7-
<!-- < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < ☺
8-
v ✰ Thanks for opening an issue! ✰
6+
<!-- < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < ☺
7+
v ✰ Thanks for opening an issue! ✰
98
v Before smashing the submit button please review the template.
10-
v Word of caution: poorly thought-out proposals may be rejected
11-
v without deliberation
9+
v Word of caution: poorly thought-out proposals may be rejected
10+
v without deliberation
1211
☺ > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > -->
1312

1413
## Milestones
@@ -32,7 +31,7 @@ versions of ibc-go to guarantee that no regression is introduced -->
3231

3332
### Other testing
3433

35-
## Migration
34+
## Migration
3635

3736
<!-- Link to migration document -->
3837

@@ -42,7 +41,7 @@ versions of ibc-go to guarantee that no regression is introduced -->
4241

4342
- [ ] Bump [go package version](https://github.com/cosmos/ibc-go/blob/main/go.mod#L3).
4443
- [ ] Change all imports starting with `github.com/cosmos/ibc-go/v{x}` to `github.com/cosmos/ibc-go/v{x+1}`.
45-
- [ ] Branch off main to create release branch in the form of `release/vx.y.z` and add branch protection rules.
44+
- [ ] Branch off main to create release branch in the form of `release/vx.y.z` and add branch protection rules.
4645
- [ ] Add branch protection rules to new release branch.
4746
- [ ] Add backport task to [`mergify.yml`](https://github.com/cosmos/ibc-go/blob/main/.github/mergify.yml)
4847
- [ ] Upgrade ibc-go version in [ibctest](https://github.com/strangelove-ventures/ibctest).
@@ -59,8 +58,13 @@ versions of ibc-go to guarantee that no regression is introduced -->
5958
- Remove any tags that might not be recommended anymore.
6059
- [ ] Update the list of [supported release lines in README.md](https://github.com/cosmos/ibc-go#releases), if necessary.
6160
- [ ] Update docs site:
62-
- [ ] Add new release branch to [`docs/versions`](https://github.com/cosmos/ibc-go/blob/main/docs/versions) file.
63-
- [ ] Add `label` and `key` to `versions` array in [`config.js`](https://github.com/cosmos/ibc-go/blob/main/docs/.vuepress/config.js#L62).
61+
- [ ] If the release is occurring on the main branch, on the latest version, then run `npm run docusaurus docs:version vX.Y.Z` in the `docs/` directory. (where `X.Y.Z` is the new version number)
62+
- [ ] If the release is occurring on an older release branch, then make a PR to the main branch called `docs: new release vX.Y.Z` doing the following:
63+
- [ ] Update the content of the docs found in `docs/versioned_docs/version-vx.y.z` if needed. (where `x.y.z` is the previous version number)
64+
- [ ] Update the version number of the older release branch by changing the version number of the older release branch in:
65+
- [ ] In `docs/versions.json`.
66+
- [ ] Rename `docs/versioned_sidebars/version-vx.y.z-sidebars.json`
67+
- [ ] Rename `docs/versioned_docs/version-vx.y.z`
6468
- [ ] Bump ibc-go version in [cosmos/interchain-accounts-demo repository](https://github.com/cosmos/interchain-accounts-demo) and create a tag.
6569
- [ ] Update the [compatibility test matrices](https://github.com/cosmos/ibc-go/tree/main/.github/compatibility-test-matrices):
6670
- Add the new release.
@@ -71,7 +75,7 @@ versions of ibc-go to guarantee that no regression is introduced -->
7175
- [ ] After changes to docs site are deployed, check [ibc.cosmos.network](https://ibc.cosmos.network) is updated.
7276
- [ ] Open issue in [SDK tutorials repo](https://github.com/cosmos/sdk-tutorials) to update tutorials to the released version of ibc-go.
7377

74-
____
78+
---
7579

7680
#### For Admin Use
7781

‎.github/PULL_REQUEST_TEMPLATE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ closes: #XXXX
1515

1616
### Commit Message / Changelog Entry
1717

18-
```bash
18+
```text
1919
type: commit message
2020
```
2121

0 commit comments

Comments
 (0)
Please sign in to comment.