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

mkdocs to docusaurus #1338

Merged
merged 42 commits into from
Jun 22, 2023
Merged

mkdocs to docusaurus #1338

merged 42 commits into from
Jun 22, 2023

Conversation

joshuafernandes
Copy link
Contributor

@joshuafernandes joshuafernandes commented May 31, 2023

Pull request checklist

Major changes to switch mkdocs -> docusaurus

Before creating the pull request

Make sure that:

Describe the change

  • Removing mkdocs and switching to docusaurus
  • Removing old versions from the versions list (still available as code though)
  • updating to use GHA
  • will need to be set to use github pages

Impacted parts

For content changes:

  • Documentation content
  • Documentation page organization

For tool changes:

  • Github Actions workflow
  • Build and QA tools configuration (for example, lint rules or Vale style)
  • MkDocs templates
  • MkDocs configuration
  • Python dependencies
  • Node dependencies and JavaScript
  • Read the Docs configuration
  • GitHub integration

After creating your PR and tests have finished

Make sure that:

Preview

@joshuafernandes joshuafernandes requested a review from a team as a code owner May 31, 2023 01:13
@joshuafernandes joshuafernandes force-pushed the docusaurus branch 3 times, most recently from 2279ef8 to b3dbb05 Compare May 31, 2023 03:33
Signed-off-by: Joshua Fernandes <joshua.fernandes@consensys.net>
joshuafernandes and others added 24 commits June 13, 2023 11:28
Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>
Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>
Signed-off-by: Byron Gravenorst <byron.gravenorst@consensys.net>
Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>
Signed-off-by: Byron Gravenorst <byron.gravenorst@consensys.net>
Signed-off-by: bgravenorst <byron.gravenorst@consensys.net>
Signed-off-by: bgravenorst <byron.gravenorst@consensys.net>
Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>
Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>

# Conflicts:
#	CI/requirements-mkdocs-material.txt
#	CI/vale/styles/Vocab/Besu/accept.txt
#	docs/private-networks/how-to/deploy/ethstats.md
#	docs/public-networks/concepts/proof-of-stake/index.md
#	docs/public-networks/concepts/the-merge.md
#	docs/public-networks/how-to/troubleshoot/performance.md
#	mkdocs.navigation.yml
Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>
Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>
Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>
Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>
Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>
Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>
Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>
Signed-off-by: Joshua Fernandes <joshua.fernandes@consensys.net>
Signed-off-by: Joshua Fernandes <joshua.fernandes@consensys.net>
Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>
Signed-off-by: Joshua Fernandes <joshua.fernandes@consensys.net>
Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>
Signed-off-by: Joshua Fernandes <joshua.fernandes@consensys.net>
Signed-off-by: Byron Gravenorst <byron.gravenorst@consensys.net>
Signed-off-by: Joshua Fernandes <joshua.fernandes@consensys.net>
Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>
Signed-off-by: Joshua Fernandes <joshua.fernandes@consensys.net>
Signed-off-by: Byron Gravenorst <byron.gravenorst@consensys.net>
Signed-off-by: Joshua Fernandes <joshua.fernandes@consensys.net>
bgravenorst and others added 14 commits June 22, 2023 09:37
Signed-off-by: bgravenorst <byron.gravenorst@consensys.net>
Signed-off-by: Joshua Fernandes <joshua.fernandes@consensys.net>
Signed-off-by: bgravenorst <byron.gravenorst@consensys.net>
Signed-off-by: Joshua Fernandes <joshua.fernandes@consensys.net>
Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>
Signed-off-by: Joshua Fernandes <joshua.fernandes@consensys.net>
* Update for OpenJ9 instructions.

Signed-off-by: Matt Nelson <85905982+non-fungible-nelson@users.noreply.github.com>

* fix lint

Signed-off-by: Matt Nelson <85905982+non-fungible-nelson@users.noreply.github.com>

* more lint/spelling.

Signed-off-by: Matt Nelson <85905982+non-fungible-nelson@users.noreply.github.com>

* edit pr

Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>

---------

Signed-off-by: Matt Nelson <85905982+non-fungible-nelson@users.noreply.github.com>
Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>
Co-authored-by: Alexandra Tran <alexandra.tran@consensys.net>
Co-authored-by: Alexandra Tran Carrillo <12214231+alexandratran@users.noreply.github.com>
Signed-off-by: Joshua Fernandes <joshua.fernandes@consensys.net>
* First draft performance troubleshooting page.

Signed-off-by: Matt Nelson <85905982+non-fungible-nelson@users.noreply.github.com>

* tweaks and linter

Signed-off-by: Matt Nelson <85905982+non-fungible-nelson@users.noreply.github.com>

* edit PR content

Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>

---------

Signed-off-by: Matt Nelson <85905982+non-fungible-nelson@users.noreply.github.com>
Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>
Co-authored-by: Alexandra Tran <alexandra.tran@consensys.net>
* Add missing tx-pool options.

Signed-off-by: bgravenorst <byron.gravenorst@consensys.net>

* Typos...

Signed-off-by: bgravenorst <byron.gravenorst@consensys.net>

* Typos...

Signed-off-by: bgravenorst <byron.gravenorst@consensys.net>

* Implement feedback.

Signed-off-by: bgravenorst <byron.gravenorst@consensys.net>

* Address reviewer feedback.

Signed-off-by: bgravenorst <byron.gravenorst@consensys.net>

---------

Signed-off-by: bgravenorst <byron.gravenorst@consensys.net>
Signed-off-by: Joshua Fernandes <joshua.fernandes@consensys.net>
Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>
Signed-off-by: Joshua Fernandes <joshua.fernandes@consensys.net>
Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>
Signed-off-by: Joshua Fernandes <joshua.fernandes@consensys.net>
Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>
Signed-off-by: Joshua Fernandes <joshua.fernandes@consensys.net>
Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>
Signed-off-by: Joshua Fernandes <joshua.fernandes@consensys.net>
Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>
Signed-off-by: Joshua Fernandes <joshua.fernandes@consensys.net>
Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>
Signed-off-by: Joshua Fernandes <joshua.fernandes@consensys.net>
Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>
Signed-off-by: Joshua Fernandes <joshua.fernandes@consensys.net>
Signed-off-by: Joshua Fernandes <joshua.fernandes@consensys.net>
joshuafernandes and others added 3 commits June 22, 2023 11:03
Signed-off-by: Joshua Fernandes <joshua.fernandes@consensys.net>
…saurus

Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>

# Conflicts:
#	.gitignore
#	docs/public-networks/get-started/system-requirements.md
#	docs/public-networks/how-to/troubleshoot/performance.md
#	docs/public-networks/reference/cli/options.md
#	docusaurus.config.js
#	src/components/HomepageCards/index.tsx
#	versions.json
#	yarn.lock
Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>
@alexandratran alexandratran merged commit cf5f263 into hyperledger:main Jun 22, 2023
7 checks passed
@alexandratran alexandratran deleted the docusaurus branch June 22, 2023 02:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants