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

Initial restructure PoC #1085

Merged
merged 38 commits into from
Aug 8, 2022
Merged

Conversation

alexandratran
Copy link
Contributor

@alexandratran alexandratran commented Jul 11, 2022

Signed-off-by: Alexandra Tran [email protected]

Pull request checklist

Use the following list to make sure your PR fits the Besu documentation quality standard.

Before creating the pull request

Make sure that:

Describe the change

  • Restructure the entire site to separate public and private network content. Common content is maintained in the public section and linked to from the private section overviews.
  • Add all redirects for moved, renamed, or deleted pages.
  • Update home page, add architecture to home page, add private and public network section overviews.
  • Combine and update:
    • Mining content into a "Configure mining" page.
    • All onchain permissioning content into one page.
    • Key management content into "Send transactions" page.
    • Client and server TLS content into one page.
    • Bootnode content into one page.
    • Protocol upgrade content into one page.

Future PRs will address more content and feature updates and additions.

Issue fixed

fixes #1078
fixes #1091
fixes #1092
fixes #1093
fixes #1094
fixes #1095
fixes #1096
fixes #1097

Impacted parts

For content changes:

  • Documentation content
  • Documentation page organization

For tool changes:

  • CircleCI workflow
  • Build and QA tools (for example, lint or vale)
  • 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

https://hyperledger-besu--1085.org.readthedocs.build/en/1085/

Signed-off-by: Alexandra Tran <[email protected]>
@alexandratran alexandratran requested a review from a team as a code owner July 11, 2022 20:40
@alexandratran alexandratran marked this pull request as draft July 11, 2022 20:40
Alexandra Tran added 5 commits July 12, 2022 10:50
Signed-off-by: Alexandra Tran <[email protected]>
Signed-off-by: Alexandra Tran <[email protected]>
Signed-off-by: Alexandra Tran <[email protected]>

# Conflicts:
#	docs/private-networks/how-to/monitor/splunk.md
#	docs/private-networks/tutorials/kubernetes/quorum-explorer.md
#	docs/public-networks/reference/engine-api/objects.md
#	docs/reference/api/index.md
#	docs/reference/api/objects.md
Alexandra Tran added 6 commits July 13, 2022 15:44
Signed-off-by: Alexandra Tran <[email protected]>
Signed-off-by: Alexandra Tran <[email protected]>
Signed-off-by: Alexandra Tran <[email protected]>
Signed-off-by: Alexandra Tran <[email protected]>
Signed-off-by: Alexandra Tran <[email protected]>
Signed-off-by: Alexandra Tran <[email protected]>
@alexandratran alexandratran mentioned this pull request Jul 16, 2022
Alexandra Tran added 4 commits July 18, 2022 11:44
Signed-off-by: Alexandra Tran <[email protected]>

# Conflicts:
#	docs/public-networks/tutorials/merge-testnet.md
Signed-off-by: Alexandra Tran <[email protected]>
@NicolasMassart
Copy link
Contributor

I think the plan should be to merge #1113 first then update this PR and so you have everything to push a complete content structure update with home page grid boxes and all the things.

@NicolasMassart NicolasMassart mentioned this pull request Jul 27, 2022
20 tasks
Alexandra Tran added 2 commits July 27, 2022 12:10
Signed-off-by: Alexandra Tran <[email protected]>

# Conflicts:
#	docs/index.md
Signed-off-by: Alexandra Tran <[email protected]>
@alexandratran alexandratran marked this pull request as ready for review July 27, 2022 20:30
@alexandratran alexandratran changed the title [WIP] initial restructure PoC Initial restructure PoC Jul 27, 2022
@alexandratran alexandratran requested a review from a team July 27, 2022 20:31
@bgravenorst
Copy link
Contributor

I only did a first pass checking language etc. I'll do a structural review next.

Alexandra Tran added 4 commits August 4, 2022 18:08
Signed-off-by: Alexandra Tran <[email protected]>

# Conflicts:
#	docs/public-networks/get-started/migrate-to-besu.md
#	mkdocs.navigation.yml
Signed-off-by: Alexandra Tran <[email protected]>
Signed-off-by: Alexandra Tran <[email protected]>
Signed-off-by: Alexandra Tran <[email protected]>
Alexandra Tran added 2 commits August 5, 2022 11:52
Signed-off-by: Alexandra Tran <[email protected]>
Signed-off-by: Alexandra Tran <[email protected]>
Copy link
Contributor

@non-fungible-nelson non-fungible-nelson left a comment

Choose a reason for hiding this comment

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

LGTM

@non-fungible-nelson non-fungible-nelson self-requested a review August 5, 2022 19:04
Copy link
Contributor

@non-fungible-nelson non-fungible-nelson left a comment

Choose a reason for hiding this comment

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

All looks good! We may have to tweak as we go forward but this is an awesome first step!

Signed-off-by: Alexandra Tran <[email protected]>
Copy link
Contributor

@NicolasMassart NicolasMassart left a comment

Choose a reason for hiding this comment

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

This PR looks good to me.
I suggest that you start with this refactoring and in another PR we could add the tags (to improve the visibility of the private public split) and icons on the two private/public sections and tags.

@alexandratran alexandratran merged commit 4a96954 into hyperledger:main Aug 8, 2022
@alexandratran alexandratran deleted the 1078-restructure branch August 8, 2022 23:49
@alexandratran alexandratran mentioned this pull request Aug 9, 2022
15 tasks
rolandtyler pushed a commit to rolandtyler/besu-docs that referenced this pull request Aug 11, 2022
* [WIP] initial restructure PoC

Signed-off-by: Alexandra Tran <[email protected]>

* finish public networks restructure

Signed-off-by: Alexandra Tran <[email protected]>

* private network restructure except tutorials

Signed-off-by: Alexandra Tran <[email protected]>

* finish private networks restructure

Signed-off-by: Alexandra Tran <[email protected]>

* add monitoring index page

Signed-off-by: Alexandra Tran <[email protected]>

* fix link errors

Signed-off-by: Alexandra Tran <[email protected]>

* more link fixes

Signed-off-by: Alexandra Tran <[email protected]>

* mkdocs fixes

Signed-off-by: Alexandra Tran <[email protected]>

* fix link and add nav tabs

Signed-off-by: Alexandra Tran <[email protected]>

* more link fixes

Signed-off-by: Alexandra Tran <[email protected]>

* update and move mining, onchain permissioning, and key mgmt content

Signed-off-by: Alexandra Tran <[email protected]>

* Update home page and add network index pages

Signed-off-by: Alexandra Tran <[email protected]>

* md fix

Signed-off-by: Alexandra Tran <[email protected]>

* update and restructure tls, bootnode, and protocol upgrade content

Signed-off-by: Alexandra Tran <[email protected]>

* initial add global variables

Signed-off-by: Alexandra Tran <[email protected]>

* final variable files

Signed-off-by: Alexandra Tran <[email protected]>

* mkdocs changes

Signed-off-by: Alexandra Tran <[email protected]>

* Some link fixes and content updates

Signed-off-by: Alexandra Tran <[email protected]>

* more link fixes

Signed-off-by: Alexandra Tran <[email protected]>

* restructure hyperledger#3 - no variables

Signed-off-by: Alexandra Tran <[email protected]>

* update private network links

Signed-off-by: Alexandra Tran <[email protected]>

* fix private network links + md

Signed-off-by: Alexandra Tran <[email protected]>

* update headings

Signed-off-by: Alexandra Tran <[email protected]>

* remove dead link

Signed-off-by: Alexandra Tran <[email protected]>

* minor homepage fix

Signed-off-by: Alexandra Tran <[email protected]>

* fix links and address feedback

Signed-off-by: Alexandra Tran <[email protected]>

* add HA and plugins material

Signed-off-by: Alexandra Tran <[email protected]>

* minor addition

Signed-off-by: Alexandra Tran <[email protected]>

* fix typo

Signed-off-by: Alexandra Tran <[email protected]>

* Integrate more feedback

Signed-off-by: Alexandra Tran <[email protected]>

* minor edits

Signed-off-by: Alexandra Tran <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants