add private and public sections tags (#1127)

* add private and public sections tags * Add private networks tag to some public pages Signed-off-by: Nicolas MASSART <nicolas.massart@consensys.net> Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net> Co-authored-by: Alexandra Tran <12214231+alexandratran@users.noreply.github.com> Co-authored-by: Alexandra Tran <alexandra.tran@consensys.net>
hyperledger · Aug 19, 2022 · d63f146 · d63f146
1 parent 144a6f3
commit d63f146
Show file tree

Hide file tree

Showing 45 changed files with 131 additions and 3 deletions.
diff --git a/docs/private-networks/.meta.yml b/docs/private-networks/.meta.yml
@@ -0,0 +1,6 @@
+---
+# Meta idems setting with yaml files is an insider only feature
+# see https://squidfunk.github.io/mkdocs-material/reference/#built-in-meta-plugin
+
+tags:
+  - private networks
diff --git a/docs/private-networks/index.md b/docs/private-networks/index.md
@@ -1,5 +1,10 @@
 ---
+# page icon, insider only, see https://squidfunk.github.io/mkdocs-material/reference/#setting-the-page-icon
+icon: material/book-lock-outline
 description: Private networks overview
+# hide feedback on this page as it's just an index page with not much content
+hide:
+  - feedback
 ---
 
 # Hyperledger Besu for private networks

diff --git a/docs/public-networks/.meta.yml b/docs/public-networks/.meta.yml
@@ -0,0 +1,6 @@
+---
+# Meta idems setting with yaml files is an insider only feature
+# see https://squidfunk.github.io/mkdocs-material/reference/#built-in-meta-plugin
+
+tags:
+  - public networks
diff --git a/docs/public-networks/concepts/events-and-logs.md b/docs/public-networks/concepts/events-and-logs.md
@@ -1,5 +1,7 @@
 ---
 description: Hyperledger Besu events and logs
+tags:
+  - private networks
 ---
 
 # Events and logs

diff --git a/docs/public-networks/concepts/genesis-file.md b/docs/public-networks/concepts/genesis-file.md
@@ -1,5 +1,7 @@
 ---
 description: Configuring a network using the genesis file
+tags:
+  - private networks
 ---
 
 # Genesis file

diff --git a/docs/public-networks/concepts/network-and-chain-id.md b/docs/public-networks/concepts/network-and-chain-id.md
@@ -1,5 +1,7 @@
 ---
 description: Besu network ID and chain ID implementation
+tags:
+  - private networks
 ---
 
 # Network ID and chain ID

diff --git a/docs/public-networks/concepts/node-keys.md b/docs/public-networks/concepts/node-keys.md
@@ -1,5 +1,7 @@
 ---
 description: Private and public key, and node address used to identify nodes
+tags:
+  - private networks
 ---
 
 # Node keys and node address

diff --git a/docs/public-networks/concepts/transactions/pool.md b/docs/public-networks/concepts/transactions/pool.md
@@ -1,5 +1,7 @@
 ---
 description: Transaction pool overview
+tags:
+  - private networks
 ---
 
 # Transaction pool

diff --git a/docs/public-networks/concepts/transactions/types.md b/docs/public-networks/concepts/transactions/types.md
@@ -1,5 +1,7 @@
 ---
 description: Description of the different transaction types
+tags:
+  - private networks
 ---
 
 # Transaction types

diff --git a/docs/public-networks/concepts/transactions/validation.md b/docs/public-networks/concepts/transactions/validation.md
@@ -1,5 +1,7 @@
 ---
 description: What transaction validation and when
+tags:
+  - private networks
 ---
 
 # Transaction validation

diff --git a/docs/public-networks/how-to/configuration-file.md b/docs/public-networks/how-to/configuration-file.md
@@ -1,5 +1,7 @@
 ---
 description: Using the Hyperledger Besu configuration file
+tags:
+  - private networks
 ---
 
 # Use the Hyperledger Besu configuration file

diff --git a/docs/public-networks/how-to/configure-ha/index.md b/docs/public-networks/how-to/configure-ha/index.md
@@ -1,5 +1,7 @@
 ---
 description: Hyperledger Besu high availability
+tags:
+  - private networks
 ---
 
 # High availability of JSON-RPC and RPC Pub/Sub APIs

diff --git a/docs/public-networks/how-to/configure-ha/sample-configuration.md b/docs/public-networks/how-to/configure-ha/sample-configuration.md
@@ -1,5 +1,7 @@
 ---
 description: Sample load balancers
+tags:
+  - private networks
 ---
 
 # Sample load balancer configurations

diff --git a/docs/public-networks/how-to/connect/configure-ports.md b/docs/public-networks/how-to/connect/configure-ports.md
@@ -1,5 +1,7 @@
 ---
 description: To enable communication you must expose Hyperledger Besu ports appropriately
+tags:
+  - private networks
 ---
 
 # Configure ports

diff --git a/docs/public-networks/how-to/connect/manage-peers.md b/docs/public-networks/how-to/connect/manage-peers.md
@@ -1,5 +1,7 @@
 ---
 description: Managing Hyperledger Besu peers
+tags:
+  - private networks
 ---
 
 # Manage peers

diff --git a/docs/public-networks/how-to/connect/specify-nat.md b/docs/public-networks/how-to/connect/specify-nat.md
@@ -1,5 +1,7 @@
 ---
 description: Configuring NAT with Hyperledger Besu
+tags:
+  - private networks
 ---
 
 # Specify the NAT method

diff --git a/docs/public-networks/how-to/connect/static-nodes.md b/docs/public-networks/how-to/connect/static-nodes.md
@@ -1,5 +1,7 @@
 ---
 description: Configuring static nodes
+tags:
+  - private networks
 ---
 
 # Static nodes

diff --git a/docs/public-networks/how-to/develop/client-libraries.md b/docs/public-networks/how-to/develop/client-libraries.md
@@ -1,5 +1,7 @@
 ---
 description: Hyperledger Besu client libraries
+tags:
+  - private networks
 ---
 
 # Use client libraries

diff --git a/docs/public-networks/how-to/develop/truffle.md b/docs/public-networks/how-to/develop/truffle.md
@@ -1,5 +1,7 @@
 ---
 description: Using Hyperledger Besu with Truffle
+tags:
+  - private networks
 ---
 
 # Use Truffle

diff --git a/docs/public-networks/how-to/monitor/index.md b/docs/public-networks/how-to/monitor/index.md
@@ -1,5 +1,7 @@
 ---
 description: Monitoring using metrics and logging
+tags:
+  - private networks
 ---
 
 # Monitor Besu

diff --git a/docs/public-networks/how-to/monitor/logging.md b/docs/public-networks/how-to/monitor/logging.md
@@ -2,6 +2,8 @@
 description: Hyperledger Besu log level setting and log formatting
 path: blob/master/besu/src/main/resources/
 source: log4j2.xml
+tags:
+  - private networks
 ---
 
 # Use logging

diff --git a/docs/public-networks/how-to/monitor/metrics.md b/docs/public-networks/how-to/monitor/metrics.md
@@ -1,5 +1,7 @@
 ---
 description: Monitoring and metrics
+tags:
+  - private networks
 ---
 
 # Use metrics to monitor node performance

diff --git a/docs/public-networks/how-to/pass-jvm-options.md b/docs/public-networks/how-to/pass-jvm-options.md
@@ -1,5 +1,7 @@
 ---
 description: Passing Java virtual machine JVM options to Hyperledger Besu at runtime
+tags:
+  - private networks
 ---
 
 # Pass JVM options

diff --git a/docs/public-networks/how-to/troubleshoot/evm-tool.md b/docs/public-networks/how-to/troubleshoot/evm-tool.md
@@ -1,5 +1,7 @@
 ---
 description: Hyperledger Besu EVM tool
+tags:
+  - private networks
 ---
 
 # Use the EVM tool

diff --git a/docs/public-networks/how-to/troubleshoot/java-flight-recorder.md b/docs/public-networks/how-to/troubleshoot/java-flight-recorder.md
@@ -1,5 +1,7 @@
 ---
 description: Using Java Flight Recorder with Hyperledger Besu
+tags:
+  - private networks
 ---
 
 # Use Java Flight Recorder

diff --git a/docs/public-networks/how-to/troubleshoot/trace-transactions.md b/docs/public-networks/how-to/troubleshoot/trace-transactions.md
@@ -1,5 +1,7 @@
 ---
 description: How to trace transactions
+tags:
+  - private networks
 ---
 
 # Trace transactions

diff --git a/docs/public-networks/how-to/use-besu-api/access-logs.md b/docs/public-networks/how-to/use-besu-api/access-logs.md
@@ -1,5 +1,7 @@
 ---
 description: Accessing logs using the Hyperledger Besu API
+tags:
+  - private networks
 ---
 
 # Access logs using the Hyperledger Besu API

diff --git a/docs/public-networks/how-to/use-besu-api/authenticate.md b/docs/public-networks/how-to/use-besu-api/authenticate.md
@@ -1,5 +1,7 @@
 ---
 description: Hyperledger Besu authentication and authorization for JSON-RPC
+tags:
+  - private networks
 ---
 
 # Authenticate and authorize JSON-RPC

diff --git a/docs/public-networks/how-to/use-besu-api/graphql.md b/docs/public-networks/how-to/use-besu-api/graphql.md
@@ -1,5 +1,7 @@
 ---
 description: How to access the Hyperledger Besu API using GraphQL
+tags:
+  - private networks
 ---
 
 # Use GraphQL over HTTP

diff --git a/docs/public-networks/how-to/use-besu-api/index.md b/docs/public-networks/how-to/use-besu-api/index.md
@@ -1,5 +1,7 @@
 ---
 description: Hyperledger Besu API
+tags:
+  - private networks
 ---
 
 # Access the Hyperledger Besu API

diff --git a/docs/public-networks/how-to/use-besu-api/json-rpc.md b/docs/public-networks/how-to/use-besu-api/json-rpc.md
@@ -1,5 +1,7 @@
 ---
 description: How to access the Hyperledger Besu API using JSON-RPC
+tags:
+  - private networks
 ---
 
 # Use JSON-RPC over HTTP, WebSocket, and IPC

diff --git a/docs/public-networks/how-to/use-besu-api/rpc-pubsub.md b/docs/public-networks/how-to/use-besu-api/rpc-pubsub.md
@@ -1,5 +1,7 @@
 ---
 description: Using RPC Pub/Sub with Hyperledger Besu WebSockets
+tags:
+  - private networks
 ---
 
 # Use RPC Pub/Sub over WebSockets

diff --git a/docs/public-networks/how-to/use-pow/mining.md b/docs/public-networks/how-to/use-pow/mining.md
@@ -1,5 +1,7 @@
 ---
 description: Using Hyperledger Besu for PoW CPU mining
+tags:
+  - private networks
 ---
 
 # Configure mining

diff --git a/docs/public-networks/index.md b/docs/public-networks/index.md
@@ -1,5 +1,10 @@
 ---
+# page icon, insider only, see https://squidfunk.github.io/mkdocs-material/reference/#setting-the-page-icon
+icon: material/book-open-variant
 description: Public networks overview
+# hide feedback on this page as it's just an index page with not much content
+hide:
+  - feedback
 ---
 
 # Hyperledger Besu for public networks

diff --git a/docs/public-networks/reference/api/index.md b/docs/public-networks/reference/api/index.md
@@ -1,5 +1,7 @@
 ---
 description: Hyperledger Besu JSON-RPC API methods reference
+tags:
+  - private networks
 ---
 
 # Besu API methods

diff --git a/docs/public-networks/reference/api/objects.md b/docs/public-networks/reference/api/objects.md
@@ -1,5 +1,7 @@
 ---
 description: Hyperledger Besu API objects reference
+tags:
+  - private networks
 ---
 
 # Besu API objects

diff --git a/docs/public-networks/reference/cli/options.md b/docs/public-networks/reference/cli/options.md
@@ -1,5 +1,7 @@
 ---
 description: Hyperledger Besu command line interface reference
+tags:
+  - private networks
 ---
 
 # Command line options

diff --git a/docs/public-networks/reference/cli/subcommands.md b/docs/public-networks/reference/cli/subcommands.md
@@ -1,5 +1,7 @@
 ---
 description: Hyperledger Besu command line interface subcommands
+tags:
+  - private networks
 ---
 
 # Subcommands

diff --git a/docs/public-networks/reference/disclosure.md b/docs/public-networks/reference/disclosure.md
@@ -1,5 +1,7 @@
 ---
 description: Hyperledger Besu responsible disclosure statement
+tags:
+  - private networks
 ---
 
 # Security disclosure policy

diff --git a/docs/public-networks/reference/evm-tool.md b/docs/public-networks/reference/evm-tool.md
@@ -1,5 +1,7 @@
 ---
 description: Hyperledger Besu EVM tool reference
+tags:
+  - private networks
 ---
 
 # EVM tool reference

diff --git a/docs/public-networks/reference/genesis-items.md b/docs/public-networks/reference/genesis-items.md
@@ -1,5 +1,7 @@
 ---
 description: Configuration items specified in the Hyperledger Besu genesis file
+tags:
+  - private networks
 ---
 
 # Genesis file items

diff --git a/docs/public-networks/reference/projects-using-besu.md b/docs/public-networks/reference/projects-using-besu.md
@@ -1,5 +1,7 @@
 ---
-description: Projects using Besu.
+description: Projects using Besu
+tags:
+  - private networks
 ---
 
 # Projects using Besu

diff --git a/docs/public-networks/reference/trace-types.md b/docs/public-networks/reference/trace-types.md
@@ -1,5 +1,7 @@
 ---
 description: Transaction trace types
+tags:
+  - private networks
 ---
 
 # Transaction trace types

diff --git a/docs/tags-index.md b/docs/tags-index.md
@@ -0,0 +1,13 @@
+---
+description: List of tagged pages in this documentation
+# hide feedback on this page as it's just a generated index page
+hide:
+- feedback
+---
+
+# Tags
+
+List of tagged pages in this documentation:
+
+<!-- This [TAGS] is an automatic placeholder for tags list -->
+[TAGS]
diff --git a/mkdocs-insider.yml b/mkdocs-insider.yml
@@ -10,18 +10,33 @@
 INHERIT: mkdocs.yml # DO NOT MODIFY THIS LINE
 
 plugins:
+  # Meta plugin to add meta content to pages in batch based on a .meta.yml file in the folder
+  # see
   meta:
     meta_file: '**/.meta.yml'
-
+  # tags plugin is not insider but has to be defined after meta plugin so has to be added here too
+  # to be loaded in the right order.
+  tags:
+    tags_file: tags-index.md
 extra:
   # indicates to the templating system that the current build uses insider
   # used to display insider only features in templates and prevent build fail on the normal version.
   is_insider: true
-
+  # tags ID, used for insider tag icons, see https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#tag-icons
+  tags:
+    private networks: priv
+    public networks: pub
 # The following has to be in this file and mkdocs.yml file because
 # readthedocs.org is overriding it wrong if not in the initial config file but in a child file.
 # The side effect is that it also allows us to have different scripts and CSS for insider theme
 extra_css:
   - assets/stylesheets/custom_theme.css
 extra_javascript:
   - assets/javascripts/custom_theme.js
+
+theme:
+  # only used with insider, see https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#tag-icons
+  icon:
+    tag:
+      priv: material/book-lock-outline
+      pub: material/book-open-variant