Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: migrate to docusaurus #13471

Merged
merged 25 commits into from
Oct 10, 2022
Merged

feat: migrate to docusaurus #13471

merged 25 commits into from
Oct 10, 2022

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Oct 6, 2022

Description

Migrates to docusaurus (PoC). Long living PR, migrating when I have actual time.

TODO

  • move folders and documentation at the right place
  • create components for {prereq}, {synopsis} ...
  • create components for having a similar look as current homepage
  • resolve +++ for displaying code snippet (https://github.com/saucelabs/docusaurus-theme-github-codeblock)
  • update theme to match current SDK colors
  • have docusaurus know to resolve relative links containing .md.
  • update pre.sh / post.sh for adding modules specs
  • runpre.sh / post.sh at build
  • versioning of old versions
  • add redirects (keep the old redirects, and redirects all links from docs.cosmos.network documentation tracking #11898)
  • update deployment documentation
  • update makefile build-docs
  • update github action (/dist folder instead of /output)
  • verify all links

Inspiration

Then


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

@alexanderbez
Copy link
Contributor

WTF is docusaurus lol?

@julienrbrt
Copy link
Member Author

julienrbrt commented Oct 7, 2022

WTF is docusaurus lol?

A tool to render our documentation, in replacement of vuepress. This PR is a PoC to see if docusaurus is suitable for us.

Basically everyone moved from vuepress to it (osmosis, cosmwasm, ignite).

@julienrbrt julienrbrt force-pushed the julien/docusaurus branch 2 times, most recently from f8c7929 to c70e121 Compare October 10, 2022 11:22
@julienrbrt julienrbrt added the T:Docs Changes and features related to documentation. label Oct 10, 2022
@julienrbrt
Copy link
Member Author

This is R4R. I will work on the GitHub fetch extension in a follow-up PR (https://github.com/saucelabs/docusaurus-theme-github-codeblock does not work).
Currently, only the main documentation will change, but v0.45 and v0.46 will still be using vuepress.
I'll gladly have this merged before 0.47, so we can have 0.47 use docusaurus as well (as the directory structure will be the same, which makes it super easy to version).

@julienrbrt julienrbrt marked this pull request as ready for review October 10, 2022 11:50
@julienrbrt julienrbrt requested a review from a team as a code owner October 10, 2022 11:50
@julienrbrt julienrbrt enabled auto-merge (squash) October 10, 2022 12:18
@alexanderbez
Copy link
Contributor

alexanderbez commented Oct 10, 2022

@julienrbrt how does one review this PR?

@tac0turtle
Copy link
Member

tac0turtle commented Oct 10, 2022

@julienrbrt how does one review this PR?

yolo ack

we should merge it here or in its own repo

@julienrbrt
Copy link
Member Author

julienrbrt commented Oct 10, 2022

I am for merging here, as for versioning we can copy the docs/ folder and the sidebar from the branch nicely at build time. Moreover, the naming of the file is important for the ordering.
But yeah, for reviewing you go on docs.cosmos.network as I have already deployed it accidentally 😅 (it should have gone in my fork, but I forgot to use the right remote)

Copy link
Contributor

@alexanderbez alexanderbez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

YOLO ACK 🦖

@julienrbrt julienrbrt merged commit a74989d into main Oct 10, 2022
@julienrbrt julienrbrt deleted the julien/docusaurus branch October 10, 2022 14:01
@julienrbrt julienrbrt mentioned this pull request Nov 2, 2022
19 tasks
larry0x pushed a commit to larry0x/cosmos-sdk that referenced this pull request May 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants