From f3f5005a8b08fc5094a98d089cbb5734aafa4a12 Mon Sep 17 00:00:00 2001 From: Nicolas MASSART Date: Thu, 9 Dec 2021 21:14:32 +0100 Subject: [PATCH] Update Home page (#171) * remove illustration * update texts * update CI Co-authored-by: bgravenorst <50852695+bgravenorst@users.noreply.github.com> --- .github/workflows/pr_preview_publish.yml | 2 +- docs/index.md | 29 ++++++++++++++---------- 2 files changed, 18 insertions(+), 13 deletions(-) diff --git a/.github/workflows/pr_preview_publish.yml b/.github/workflows/pr_preview_publish.yml index 505c38ff..6389d454 100644 --- a/.github/workflows/pr_preview_publish.yml +++ b/.github/workflows/pr_preview_publish.yml @@ -12,7 +12,7 @@ jobs: - name: checkout code from repos uses: actions/checkout@v2 with: - ref: refs/pull/${{ github.event.number }}/merge + ref: refs/pull/${{ github.event.number }}/merge # required to pull the PR code instead of the main one fetch-depth: 0 # Required for mkdocs to be able to display pages last update info - name: set environment vars from .env file diff --git a/docs/index.md b/docs/index.md index 89806aaa..d3bef419 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,9 +2,8 @@ template: home.html title: GoQuorum Enterprise Ethereum Client description: GoQuorum is an open-source Ethereum client developed under the LGPL license and written in Go. - GoQuorum is an Ethereum-based protocol that runs private, permissioned networks. GoQuorum implements - Proof of Authority (IBFT, QBFT, Raft, and Clique) consensus mechanisms. -illustration: assets/illustrations/undraw_completed_steps_re_h9wc.svg + GoQuorum runs private, permissioned networks and implements proof of authority (IBFT, QBFT, Raft, and Clique) + consensus mechanisms. hide: - toc @@ -13,36 +12,35 @@ hide: profiles: - link: deploy/install/getting-started-overview/ title: Deploy GoQuorum - text: Install GoQuorum using one of our recommended methods, or upgrade from an earlier version. - Run the Quorum Developer Quickstart to quickly set up a local development environment. + text: Install GoQuorum or upgrade from an earlier version. + Run the Quorum Developer Quickstart to set up a local development environment. image: assets/illustrations/undraw_to_the_stars_qhyy.svg - link: configure-and-manage/configure/consensus-protocols/ibft/ title: Configure and manage - text: Information about how to configure and manage GoQuorum, including consensus protocols, genesis files, - permissioning, monitoring, and other network configuration. + text: Configure and manage GoQuorum consensus protocols, genesis files, permissioning, + monitoring, and other network components. image: assets/illustrations/undraw_programming_re_kg9v.svg - link: develop/connecting-to-a-node/ title: Develop applications - text: Information about how to connect to nodes, access the JSON-RPC-APIs, and use client libraries to develop + text: Connect to nodes, access the JSON-RPC APIs, and use client libraries to develop applications for the GoQuorum network. image: assets/illustrations/undraw_web_development_0l6v.svg - link: concepts/blockchain-basics/what-is-blockchain/ title: Learn about GoQuorum - text: Conceptual information covering basic blockchain concepts and GoQuorum architecture and features. + text: Read about blockchain concepts and GoQuorum architecture and features. image: assets/illustrations/undraw_knowledge_g-5-gf.svg - link: tutorials/quorum-dev-quickstart/getting-started/ title: Try the tutorials - text: Tutorials to use the Quorum Developer Quickstart, deploy and interact with smart contracts, - and create private networks. + text: Use the Quorum Developer Quickstart, deploy and interact with smart contracts, and create private networks. image: assets/illustrations/undraw_setup_wizard_re_nday.svg - link: reference/cli-syntax/ title: Reference information - text: Reference information including APIs, command line options, and other technical descriptions. + text: See APIs, command line options, and other technical descriptions. image: assets/illustrations/undraw_preferences_popup_wbfw.svg --- @@ -54,6 +52,13 @@ Configure the landing page [using meta tags](https://squidfunk.github.io/mkdocs- --- title: Page title description: Page description + +hide: +- toc +- navigation + +illustration: assets/illustrations/undraw_completed_steps_re_h9wc.svg + links: - link: link-url/ title: Link title