From 8e49d1571d52da8555847b9901f9d52d5c20ddb1 Mon Sep 17 00:00:00 2001 From: Adam Schmideg Date: Tue, 1 Oct 2019 10:40:09 +0200 Subject: [PATCH] Move all documentation below /docs (#20072) * Move pages one level deeper under the /docs folder and fix broken links * Fix broken links * Flatten clef/qubes links to clef * Remove path debugging from main template --- _config.yml | 19 ++++++++++++++++--- _data/navbar.yml | 2 +- _includes/link.html | 2 +- _layouts/default.html | 2 +- docs/_clef/Overview.md | 8 ++++---- docs/_clef/Setup.md | 14 +++++++------- docs/_clef/apis.md | 2 +- docs/_doc/Connecting-to-the-network.md | 2 +- docs/_doc/Ethereum-Specification.md | 2 +- docs/_doc/Ethereum-on-Android.md | 2 +- .../Japanese-Contracts-and-Transactions.md | 2 +- .../Setting-up-monitoring-on-local-cluster.md | 2 +- ...ing-up-private-network-or-local-cluster.md | 4 ++-- docs/_install-and-build/Backup--restore.md | 4 ++-- docs/_install-and-build/Build-from-Source.md | 5 +++-- docs/_install-and-build/Developers-Guide.md | 14 +++++++------- docs/_interface/JavaScript-Console.md | 6 +++--- docs/_interface/Management-APIs.md | 2 +- docs/_interface/Managing-your-accounts.md | 6 +++--- docs/_legacy/Contract-Tutorial.md | 2 +- docs/_legacy/Mining.md | 12 ++++++------ docs/_legacy/Swarm---TODO.md | 2 +- .../Swarm---distributed-preimage-archive.md | 6 +++--- docs/_legacy/geth.md | 12 ++++++------ docs/_support/FAQ.md | 2 +- docs/_whisper/How-to-Whisper.md | 2 +- docs/index.md | 16 ++++++++-------- install.md | 2 +- 28 files changed, 85 insertions(+), 71 deletions(-) diff --git a/_config.yml b/_config.yml index cea599ae08..4d98e8efcd 100644 --- a/_config.yml +++ b/_config.yml @@ -15,52 +15,65 @@ defaults: - scope: path: "*" values: - root: "." + root: "../.." - scope: path: "*/*" values: - root: ".." + root: "../../.." + - scope: + path: "*/*/*" + values: + root: "../../../.." -default_root: ".." +default_root: "../../.." collections_dir: docs collections: install-and-build: output: true + permalink: docs/:collection/:slug caption: Install and build sidebar_index: 1 frontpage: _install-and-build/Installing-Geth.md interface: output: true + permalink: docs/:collection/:slug caption: Interacting with Geth sidebar_index: 2 support: output: true + permalink: docs/:collection/:slug caption: Issues and support sidebar_index: 3 developers: output: true + permalink: docs/:collection/:slug caption: Developer docs sidebar_index: 4 clef: output: true + permalink: docs/:collection/:slug caption: Clef sidebar_index: 5 frontpage: _clef/Overview.md whisper: output: true + permalink: docs/:collection/:slug caption: Whisper sidebar_index: 6 frontpage: _whisper/Whisper-Overview.md rpc: output: true + permalink: docs/:collection/:slug caption: JSON RPC APIs sidebar_index: 7 doc: output: true + permalink: docs/:collection/:slug caption: Other sidebar_index: 8 legacy: output: true + permalink: docs/:collection/:slug caption: Legacy content sidebar_index: 9 diff --git a/_data/navbar.yml b/_data/navbar.yml index 4ad130e2ae..d85d1d6868 100644 --- a/_data/navbar.yml +++ b/_data/navbar.yml @@ -1,3 +1,3 @@ -Install: /install-and-build/Installing-Geth +Install: /docs/install-and-build/installing-geth Downloads: /downloads Documentation: /docs diff --git a/_includes/link.html b/_includes/link.html index 07b7a54722..b66e4a17e1 100644 --- a/_includes/link.html +++ b/_includes/link.html @@ -1 +1 @@ -{% if page.root %}{% assign root=page.root %}{% else %}{% assign root=site.default_root %}{% endif %}{{ include.url | remove: ".html" | prepend: root | replace: '//', '/' }} +{% if page.root %}{% assign root=page.root %}{% else %}{% assign root=site.default_root %}{% endif %}{{ include.url | remove: ".html" | prepend: root | replace: '//', '/' }} \ No newline at end of file diff --git a/_layouts/default.html b/_layouts/default.html index 0d7bc47a43..34dd1b4487 100644 --- a/_layouts/default.html +++ b/_layouts/default.html @@ -26,7 +26,7 @@ common-js: - Go Ethereum + Go Ethereum