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

Insider features #1113

Merged
merged 11 commits into from
Jul 27, 2022
Merged

Conversation

NicolasMassart
Copy link
Contributor

@NicolasMassart NicolasMassart commented Jul 21, 2022

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

Adding MkDocs Material theme insider specific features:

  • optional config file to build with or without insider
  • feedback widget
  • feedback form
  • cookies consent
  • dark/light theme

NOTE: tags will be implemented in another PR as they require change in the content. Maybe #1085

Issue fixed

fixes #1112

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--1113.org.readthedocs.build/en/1113/

Signed-off-by: Nicolas MASSART <nicolas.massart@consensys.net>
Signed-off-by: Nicolas MASSART <nicolas.massart@consensys.net>
Signed-off-by: Nicolas MASSART <nicolas.massart@consensys.net>
Signed-off-by: Nicolas MASSART <nicolas.massart@consensys.net>
Signed-off-by: Nicolas MASSART <nicolas.massart@consensys.net>
@NicolasMassart NicolasMassart requested a review from a team as a code owner July 21, 2022 14:35
Signed-off-by: Nicolas MASSART <nicolas.massart@consensys.net>
Signed-off-by: Nicolas MASSART <nicolas.massart@consensys.net>
add tags index
prepare for meta file
clean extensions and plugin files (was mixed)
add socials

Signed-off-by: Nicolas MASSART <nicolas.massart@consensys.net>
Signed-off-by: Nicolas MASSART <nicolas.massart@consensys.net>
@NicolasMassart NicolasMassart marked this pull request as draft July 26, 2022 13:54
@NicolasMassart NicolasMassart added the DocOps Related to documentation system, tools and CI label Jul 26, 2022
Signed-off-by: Nicolas MASSART <nicolas.massart@consensys.net>
and invert color
remove tag file

Signed-off-by: Nicolas MASSART <nicolas.massart@consensys.net>
@NicolasMassart NicolasMassart mentioned this pull request Jul 27, 2022
15 tasks
@NicolasMassart NicolasMassart marked this pull request as ready for review July 27, 2022 17:12
@NicolasMassart NicolasMassart enabled auto-merge (squash) July 27, 2022 17:15
@NicolasMassart NicolasMassart self-assigned this Jul 27, 2022
Copy link
Contributor

@alexandratran alexandratran left a comment

Choose a reason for hiding this comment

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

LGTM!

@NicolasMassart NicolasMassart merged commit daf2560 into hyperledger:main Jul 27, 2022
rolandtyler pushed a commit to rolandtyler/besu-docs that referenced this pull request Aug 11, 2022
* add dark/light theme
* cookies consent
* adjust colours
* feedback widget
* add a specific insider config
* add grid on index
* clean extensions and plugin files (was mixed)
* add socials

Signed-off-by: Nicolas MASSART <nicolas.massart@consensys.net>
@NicolasMassart NicolasMassart deleted the insider-features branch September 7, 2022 13:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
DocOps Related to documentation system, tools and CI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Implement MkDocs Material insider features
2 participants