Skip to content

Commit 2ae92a2

Browse files
bgravenorstEric Linjoshuafernandes
authored
Versioning for Teku Docs. (#474)
* Versioning for Teku Docs. Signed-off-by: bgravenorst <byron.gravenorst@consensys.net> * Update JS script. Signed-off-by: bgravenorst <byron.gravenorst@consensys.net> * Fix prettier errors. Signed-off-by: bgravenorst <byron.gravenorst@consensys.net> * Fix redirects. Signed-off-by: bgravenorst <byron.gravenorst@consensys.net> * Fix prettier errors. Signed-off-by: bgravenorst <byron.gravenorst@consensys.net> * Redirect error. Signed-off-by: bgravenorst <byron.gravenorst@consensys.net> * Broken links. Signed-off-by: bgravenorst <byron.gravenorst@consensys.net> * Broken links. Signed-off-by: bgravenorst <byron.gravenorst@consensys.net> * Broken links. Signed-off-by: bgravenorst <byron.gravenorst@consensys.net> * Update themes. Signed-off-by: bgravenorst <byron.gravenorst@consensys.net> * Remove redocusaurus. Signed-off-by: bgravenorst <byron.gravenorst@consensys.net> * test vercel redirect Signed-off-by: Eric Lin <eric.lin@consensys.net> * redirect fix 1 Signed-off-by: Eric Lin <eric.lin@consensys.net> * redirect fix 2 Signed-off-by: Eric Lin <eric.lin@consensys.net> * redirect fix 3 Signed-off-by: Eric Lin <eric.lin@consensys.net> * redirect fix 4 Signed-off-by: Eric Lin <eric.lin@consensys.net> * undo redirect due to infinite Signed-off-by: Eric Lin <eric.lin@consensys.net> * remove client redirect Signed-off-by: Eric Lin <eric.lin@consensys.net> * remove hardcode redirects Signed-off-by: Eric Lin <eric.lin@consensys.net> * revert changes Signed-off-by: Eric Lin <eric.lin@consensys.net> * omit stable path Signed-off-by: Eric Lin <eric.lin@consensys.net> * footer links Signed-off-by: Eric Lin <eric.lin@consensys.net> * adding in redirects back and fixing latest->next * test next-> development as path Signed-off-by: Joshua Fernandes <joshua.fernandes@consensys.net> --------- Signed-off-by: bgravenorst <byron.gravenorst@consensys.net> Signed-off-by: Eric Lin <eric.lin@consensys.net> Signed-off-by: Joshua Fernandes <joshua.fernandes@consensys.net> Co-authored-by: Eric Lin <eric.lin@consensys.net> Co-authored-by: Joshua Fernandes <joshua.fernandes@consensys.net>
1 parent 60e3b61 commit 2ae92a2

71 files changed

Lines changed: 11167 additions & 616 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/concepts/merge.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,13 @@ You can run Teku as a consensus client with:
2525

2626
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).
2727

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

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

3232
### Execution clients
3333

34-
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.
34+
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.
3535

3636
### Consensus clients
3737

‎docs/how-to/configure/tls.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,6 @@ In the command:
7676
[Known clients file]: ../../tutorials/configure-external-signer-tls.md#3-create-the-known-clients-file
7777
[Teku's password-protected PKCS12 or JKS keystore and password file]: ../../tutorials/configure-external-signer-tls.md#teku-keystore-and-password-file
7878
[Web3Signer's password-protected PKCS12 or JKS truststore and password file]: ../../tutorials/configure-external-signer-tls.md#2-create-the-truststore-and-password-file
79-
[Hyperledger Besu]: https://besu.hyperledger.org/en/stable/HowTo/Get-Started/Installation-Options/Options/
79+
[Hyperledger Besu]: https://besu.hyperledger.org/stable/public-networks/get-started/install
8080
[Slashing protection]: https://docs.web3signer.consensys.net/en/latest/Concepts/Slashing-Protection/
8181
[configure your slashing protection database]: https://docs.web3signer.consensys.net/en/latest/HowTo/Configure-Slashing-Protection/

‎docs/reference/rest.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,6 @@ When enabling the API documentation endpoint, specify:
8383

8484
<!-- Links -->
8585

86-
[REST API documentation]: /api
86+
[REST API documentation]: https://consensys.github.io/teku/
8787
[Postman]: https://www.postman.com/
8888
[cURL]: https://curl.haxx.se/

‎docs/tutorials/configure-external-signer-tls.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ teku --network=goerli \
172172
<!-- links -->
173173
174174
[Web3Signer]: https://docs.web3signer.consensys.net/en/latest/
175-
[Hyperledger Besu]: https://besu.hyperledger.org/en/stable/HowTo/Get-Started/Installation-Options/Options/
175+
[Hyperledger Besu]: https://besu.hyperledger.org/development/public-networks/get-started/install
176176
[Infura]: https://infura.io/
177-
[ETH1 Goerli node]: https://besu.hyperledger.org/en/stable/HowTo/Get-Started/Starting-node/#run-a-node-on-goerli-testnet
177+
[ETH1 Goerli node]: https://besu.hyperledger.org/development/public-networks/get-started/start-node#run-a-node-on-goerli-testnet
178178
[Web3Signer slashing protection]: https://docs.web3signer.consensys.net/en/latest/Concepts/Slashing-Protection/

‎docusaurus.config.js‎

Lines changed: 28 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -4,40 +4,6 @@ const darkCodeTheme = require("prism-react-renderer/themes/dracula");
44
const isDev = process.env.NODE_ENV === "development";
55
const baseUrl = isDev ? "/" : "/";
66

7-
/**
8-
* @type {import('redocusaurus').PresetEntry}
9-
*/
10-
const redocusaurus = [
11-
"redocusaurus",
12-
{
13-
specs: [
14-
{
15-
id: "using-remote-url",
16-
// Remote File
17-
spec: "https://raw.githubusercontent.com/ConsenSys/teku/gh-pages/latest.json",
18-
route: "/api/",
19-
},
20-
],
21-
theme: {
22-
/**
23-
* Highlight color for docs
24-
*/
25-
primaryColor: "#ed774f",
26-
primaryColorDark: "#ed774f",
27-
/**
28-
* Options to pass to redoc
29-
* @see https://github.com/redocly/redoc#redoc-options-object
30-
*/
31-
options: { disableSearch: true },
32-
/**
33-
* Options to pass to override RedocThemeObject
34-
* @see https://github.com/Redocly/redoc#redoc-theme-object
35-
*/
36-
theme: {},
37-
},
38-
},
39-
];
40-
417
/** @type {import('@docusaurus/types').Config} */
428
const config = {
439
title: "Teku documentation",
@@ -70,8 +36,22 @@ const config = {
7036
sidebarPath: require.resolve("./sidebars.js"),
7137
// Set a base path separate from default /docs
7238
editUrl: "https://github.com/ConsenSys/doc.teku/tree/master/",
73-
path: "docs",
7439
routeBasePath: "/",
40+
path: "./docs",
41+
includeCurrentVersion: true,
42+
lastVersion: "23.6.2",
43+
versions: {
44+
//defaults to the ./docs folder
45+
// using 'development' instead of 'next' as path
46+
current: {
47+
label: "development",
48+
path: "development",
49+
},
50+
//the last stable release in the versioned_docs/version-stable
51+
"23.6.2": {
52+
label: "stable (23.6.2)",
53+
},
54+
},
7555
// @ts-ignore
7656
// eslint-disable-next-line global-require
7757
remarkPlugins: [require("remark-docusaurus-tabs")],
@@ -84,14 +64,12 @@ const config = {
8464
],
8565
showLastUpdateAuthor: false,
8666
showLastUpdateTime: true,
87-
includeCurrentVersion: true,
8867
},
8968
theme: {
9069
customCss: require.resolve("./src/css/custom.css"),
9170
},
9271
},
9372
],
94-
redocusaurus,
9573
],
9674

9775
themeConfig:
@@ -168,7 +146,12 @@ const config = {
168146
},
169147
{
170148
label: "API",
171-
to: "/api/",
149+
to: "https://consensys.github.io/teku/",
150+
},
151+
{
152+
type: "docsVersionDropdown",
153+
position: "right",
154+
dropdownActiveClassDisabled: true,
172155
},
173156
{
174157
href: "https://github.com/ConsenSys/teku",
@@ -190,19 +173,19 @@ const config = {
190173
items: [
191174
{
192175
label: "Introduction",
193-
to: "introduction",
176+
to: "/introduction",
194177
},
195178
{
196179
label: "Get started",
197-
to: "/category/get-started",
180+
to: "/get-started",
198181
},
199182
{
200183
label: "How to guides",
201-
to: "/category/how-to",
184+
to: "/how-to",
202185
},
203186
{
204187
label: "Tutorials",
205-
to: "/category/tutorials",
188+
to: "/tutorials",
206189
},
207190
],
208191
},
@@ -211,7 +194,7 @@ const config = {
211194
items: [
212195
{
213196
label: "Command line",
214-
to: "reference/cli",
197+
to: "/reference/cli",
215198
},
216199
{
217200
label: "REST API",
@@ -424,10 +407,9 @@ const config = {
424407
from: "/category/connect-to-a-network",
425408
to: "/get-started/connect",
426409
},
427-
// prettier-ignore
428410
{
429-
from: "/category/how-to",
430-
to: "/how-to",
411+
from: "/category/how-to",
412+
to: "/how-to",
431413
},
432414
{
433415
from: "/category/configure",

0 commit comments

Comments
 (0)