Skip to content

Commit

Permalink
Update site configuration (#460)
Browse files Browse the repository at this point in the history
* Update site configuration

* npm install

* fix attempt

* prettier-ignore

* prettier-ignore

* update readme
  • Loading branch information
alexandratran authored Jun 23, 2023
1 parent 645edce commit 0d45098
Show file tree
Hide file tree
Showing 19 changed files with 747 additions and 886 deletions.
24 changes: 0 additions & 24 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

33 changes: 0 additions & 33 deletions .github/ISSUE_TEMPLATE/content_issue.md

This file was deleted.

31 changes: 0 additions & 31 deletions .github/ISSUE_TEMPLATE/tool_issue.md

This file was deleted.

55 changes: 0 additions & 55 deletions .github/pull_request_template.md

This file was deleted.

4 changes: 0 additions & 4 deletions .husky/commit-msg

This file was deleted.

4 changes: 0 additions & 4 deletions .husky/pre-commit

This file was deleted.

4 changes: 0 additions & 4 deletions .husky/prepare-commit-msg

This file was deleted.

24 changes: 5 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,7 @@
# ConsenSys Teku
# Teku documentation

This documentation repo is built using [Docusaurus 2](https://docusaurus.io/).
This documentation repository is built using [Docusaurus](https://docusaurus.io/), and the doc
site is published at [`docs.teku.consensys.net`](https://docs.teku.consensys.net/).

See [more](https://docs-template.consensys.net/) information about using Docusaurus quickly.

### Contributing & Local Development

$ npm install
$ npm run prepare
$ npm start
$ git commit

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Build

$ npm run build
$ npm run serve

This command generates static content into the `build` directory.
View the [ConsenSys doc contribution guidelines](https://docs-template.consensys.net/) for
information about submitting documentation changes and previewing the site locally.
3 changes: 2 additions & 1 deletion docs/get-started/connect/_category_.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"label": "Connect to a network",
"position": 3,
"link": {
"type": "generated-index"
"type": "generated-index",
"slug": "/get-started/connect"
}
}
3 changes: 2 additions & 1 deletion docs/get-started/install/_category_.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"label": "Install Teku",
"position": 1,
"link": {
"type": "generated-index"
"type": "generated-index",
"slug": "/get-started/install"
}
}
3 changes: 2 additions & 1 deletion docs/how-to/configure/_category_.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"label": "Configure",
"position": 1,
"link": {
"type": "generated-index"
"type": "generated-index",
"slug": "/how-to/configure"
}
}
3 changes: 2 additions & 1 deletion docs/how-to/find-and-connect/_category_.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"label": "Find and connect to peers",
"position": 3,
"link": {
"type": "generated-index"
"type": "generated-index",
"slug": "how-to/find-and-connect"
}
}
3 changes: 2 additions & 1 deletion docs/how-to/monitor/_category_.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"label": "Monitor nodes",
"position": 4,
"link": {
"type": "generated-index"
"type": "generated-index",
"slug": "/how-to/monitor"
}
}
3 changes: 2 additions & 1 deletion docs/how-to/use-external-signer/_category_.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"label": "Use an external signer",
"position": 2,
"link": {
"type": "generated-index"
"type": "generated-index",
"slug": "/how-to/use-external-signer"
}
}
53 changes: 42 additions & 11 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -180,16 +180,6 @@ const config = {
className: "header-discord-link",
position: "right",
},
{
href: "https://twitter.com/consensys",
className: "header-twitter-link",
position: "right",
},
{
href: "https://hub.docker.com/r/consensys/teku",
className: "header-dockerhub-link",
position: "right",
},
],
},
footer: {
Expand Down Expand Up @@ -333,7 +323,7 @@ const config = {
},
{
from: "/category/external-signing",
to: "/category/use-an-external-signer",
to: "/how-to/use-external-signer",
},
{
from: "/HowTo/External-Signer/Use-External-Signer",
Expand Down Expand Up @@ -422,6 +412,47 @@ const config = {
from: "/Reference/CLI/CLI-Syntax",
to: "/reference/cli",
},
{
from: "/category/get-started",
to: "/get-started",
},
{
from: "/category/install-teku",
to: "/get-started/install",
},
{
from: "/category/connect-to-a-network",
to: "/get-started/connect",
},
// prettier-ignore
{
from: "/category/how-to",
to: "/how-to",
},
{
from: "/category/configure",
to: "/how-to/configure",
},
{
from: "/category/use-an-external-signer",
to: "/how-to/use-external-signer",
},
{
from: "/category/find-and-connect-to-peers",
to: "/how-to/find-and-connect",
},
{
from: "/category/monitor-nodes",
to: "/how-to/monitor",
},
{
from: "/category/concepts",
to: "/concepts",
},
{
from: "/category/tutorials",
to: "/tutorials",
},
],
},
],
Expand Down
Loading

1 comment on commit 0d45098

@vercel
Copy link

@vercel vercel bot commented on 0d45098 Jun 23, 2023

Choose a reason for hiding this comment

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

Successfully deployed to the following URLs:

doc-teku – ./

doc-teku-infura-web.vercel.app
docs.teku.consensys.net
doc-teku-git-main-infura-web.vercel.app

Please sign in to comment.