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

Versioning for Teku Docs. #474

Merged
merged 25 commits into from
Jul 31, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/concepts/merge.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,13 @@ You can run Teku as a consensus client with:

After The Merge, a full Ethereum Mainnet node is a combination of an execution client (previously called an [Ethereum 1.0](https://blog.ethereum.org/2022/01/24/the-great-eth2-renaming/) client) and a consensus client (previously called an [Ethereum 2.0](https://blog.ethereum.org/2022/01/24/the-great-eth2-renaming/) client).

Execution and consensus clients communicate with each other using the [Engine API](https://besu.hyperledger.org/en/latest/HowTo/Interact/APIs/Engine-API/).
Execution and consensus clients communicate with each other using the [Engine API](https://besu.hyperledger.org/development/public-networks/how-to/use-engine-api).

![Ethereum Merge node](../images/execution-consensus-clients.png)

### Execution clients

Execution clients, such as [Besu](https://besu.hyperledger.org/en/stable/), manage the execution layer, including executing transactions and updating the world state. Execution clients serve [JSON-RPC API](https://besu.hyperledger.org/en/stable/Reference/API-Methods/) requests and communicate with each other in a peer-to-peer network.
Execution clients, such as [Besu](https://besu.hyperledger.org/), manage the execution layer, including executing transactions and updating the world state. Execution clients serve [JSON-RPC API](https://besu.hyperledger.org/development/public-networks/reference/api) requests and communicate with each other in a peer-to-peer network.

### Consensus clients

Expand Down
2 changes: 1 addition & 1 deletion docs/how-to/configure/tls.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,6 @@ In the command:
[Known clients file]: ../../tutorials/configure-external-signer-tls.md#3-create-the-known-clients-file
[Teku's password-protected PKCS12 or JKS keystore and password file]: ../../tutorials/configure-external-signer-tls.md#teku-keystore-and-password-file
[Web3Signer's password-protected PKCS12 or JKS truststore and password file]: ../../tutorials/configure-external-signer-tls.md#2-create-the-truststore-and-password-file
[Hyperledger Besu]: https://besu.hyperledger.org/en/stable/HowTo/Get-Started/Installation-Options/Options/
[Hyperledger Besu]: https://besu.hyperledger.org/stable/public-networks/get-started/install
[Slashing protection]: https://docs.web3signer.consensys.net/en/latest/Concepts/Slashing-Protection/
[configure your slashing protection database]: https://docs.web3signer.consensys.net/en/latest/HowTo/Configure-Slashing-Protection/
2 changes: 1 addition & 1 deletion docs/reference/rest.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,6 @@ When enabling the API documentation endpoint, specify:

<!-- Links -->

[REST API documentation]: /api
[REST API documentation]: https://consensys.github.io/teku/
[Postman]: https://www.postman.com/
[cURL]: https://curl.haxx.se/
4 changes: 2 additions & 2 deletions docs/tutorials/configure-external-signer-tls.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ teku --network=goerli \
<!-- links -->

[Web3Signer]: https://docs.web3signer.consensys.net/en/latest/
[Hyperledger Besu]: https://besu.hyperledger.org/en/stable/HowTo/Get-Started/Installation-Options/Options/
[Hyperledger Besu]: https://besu.hyperledger.org/development/public-networks/get-started/install
[Infura]: https://infura.io/
[ETH1 Goerli node]: https://besu.hyperledger.org/en/stable/HowTo/Get-Started/Starting-node/#run-a-node-on-goerli-testnet
[ETH1 Goerli node]: https://besu.hyperledger.org/development/public-networks/get-started/start-node#run-a-node-on-goerli-testnet
[Web3Signer slashing protection]: https://docs.web3signer.consensys.net/en/latest/Concepts/Slashing-Protection/
74 changes: 28 additions & 46 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,40 +4,6 @@ const darkCodeTheme = require("prism-react-renderer/themes/dracula");
const isDev = process.env.NODE_ENV === "development";
const baseUrl = isDev ? "/" : "/";

/**
* @type {import('redocusaurus').PresetEntry}
*/
const redocusaurus = [
"redocusaurus",
{
specs: [
{
id: "using-remote-url",
// Remote File
spec: "https://raw.githubusercontent.com/ConsenSys/teku/gh-pages/latest.json",
route: "/api/",
},
],
theme: {
/**
* Highlight color for docs
*/
primaryColor: "#ed774f",
primaryColorDark: "#ed774f",
/**
* Options to pass to redoc
* @see https://github.com/redocly/redoc#redoc-options-object
*/
options: { disableSearch: true },
/**
* Options to pass to override RedocThemeObject
* @see https://github.com/Redocly/redoc#redoc-theme-object
*/
theme: {},
},
},
];

/** @type {import('@docusaurus/types').Config} */
const config = {
title: "Teku documentation",
Expand Down Expand Up @@ -70,8 +36,22 @@ const config = {
sidebarPath: require.resolve("./sidebars.js"),
// Set a base path separate from default /docs
editUrl: "https://github.com/ConsenSys/doc.teku/tree/master/",
path: "docs",
routeBasePath: "/",
path: "./docs",
includeCurrentVersion: true,
lastVersion: "23.6.2",
versions: {
//defaults to the ./docs folder
// using 'development' instead of 'next' as path
current: {
label: "development",
path: "development",
},
//the last stable release in the versioned_docs/version-stable
"23.6.2": {
label: "stable (23.6.2)",
},
},
// @ts-ignore
// eslint-disable-next-line global-require
remarkPlugins: [require("remark-docusaurus-tabs")],
Expand All @@ -84,14 +64,12 @@ const config = {
],
showLastUpdateAuthor: false,
showLastUpdateTime: true,
includeCurrentVersion: true,
},
theme: {
customCss: require.resolve("./src/css/custom.css"),
},
},
],
redocusaurus,
],

themeConfig:
Expand Down Expand Up @@ -168,7 +146,12 @@ const config = {
},
{
label: "API",
to: "/api/",
to: "https://consensys.github.io/teku/",
},
{
type: "docsVersionDropdown",
position: "right",
dropdownActiveClassDisabled: true,
},
{
href: "https://github.com/ConsenSys/teku",
Expand All @@ -190,19 +173,19 @@ const config = {
items: [
{
label: "Introduction",
to: "introduction",
to: "/introduction",
},
{
label: "Get started",
to: "/category/get-started",
to: "/get-started",
},
{
label: "How to guides",
to: "/category/how-to",
to: "/how-to",
},
{
label: "Tutorials",
to: "/category/tutorials",
to: "/tutorials",
},
],
},
Expand All @@ -211,7 +194,7 @@ const config = {
items: [
{
label: "Command line",
to: "reference/cli",
to: "/reference/cli",
},
{
label: "REST API",
Expand Down Expand Up @@ -424,10 +407,9 @@ const config = {
from: "/category/connect-to-a-network",
to: "/get-started/connect",
},
// prettier-ignore
{
from: "/category/how-to",
to: "/how-to",
from: "/category/how-to",
to: "/how-to",
},
{
from: "/category/configure",
Expand Down
Loading