From 21ee44bbaf5423e7badac276b4b43d8a22093308 Mon Sep 17 00:00:00 2001 From: ligi Date: Mon, 25 Jan 2021 12:45:02 +0100 Subject: [PATCH] docs: fix some broken links (#22167) This fixes broken links that where reported via: https://validator.w3.org/checklink?uri=http%3A%2F%2Fgeth.ethereum.org%2Fdocs%2F&hide_type=all&recursive=on&depth=10&check=Check It also moves the 'getting started' pages from /getting-started/... to /docs/getting-started/... In order to not break any old links, redirects from the old location have been added. Co-authored-by: Felix Lange --- _config.yml | 1 + _layouts/redirect.html | 11 +++++++++++ docs/_dapp/mobile-accounts.md | 2 +- docs/_dapp/native-accounts.md | 2 +- docs/_getting-started/dev-mode.md | 5 ++++- docs/_install-and-build/Installing-Geth.md | 2 +- docs/_interface/FAQ.md | 2 +- docs/_interface/mining.md | 6 +++--- docs/_interface/peer-to-peer.md | 2 +- docs/_legacy/Contract-Tutorial.md | 2 +- docs/_rpc/ns-admin.md | 4 ++-- docs/_rpc/ns-debug.md | 2 +- index.html | 2 +- redirects/dev-mode.md | 7 +++++++ redirects/private-net.md | 7 +++++++ 15 files changed, 43 insertions(+), 14 deletions(-) create mode 100644 _layouts/redirect.html create mode 100644 redirects/dev-mode.md create mode 100644 redirects/private-net.md diff --git a/_config.yml b/_config.yml index cbef41c89b..33affb336d 100644 --- a/_config.yml +++ b/_config.yml @@ -28,6 +28,7 @@ collections: getting-started: output: true caption: Getting Started + permalink: docs/:collection/:slug sidebar_index: 1 frontpage: _getting-started/index.md install-and-build: diff --git a/_layouts/redirect.html b/_layouts/redirect.html new file mode 100644 index 0000000000..249ee2f35a --- /dev/null +++ b/_layouts/redirect.html @@ -0,0 +1,11 @@ + + + + + + + + +

This page has been moved to {{page.new_url}}.

+ + diff --git a/docs/_dapp/mobile-accounts.md b/docs/_dapp/mobile-accounts.md index 1b9bbd2d07..4545b647ca 100644 --- a/docs/_dapp/mobile-accounts.md +++ b/docs/_dapp/mobile-accounts.md @@ -48,7 +48,7 @@ Cryptography](sec2), implemented by the [`libsecp256k`](secp256k1) library and w [`github.com/ethereum/go-ethereum/accounts`](accounts-go). Accounts are stored on disk in the [Web3 Secret Storage](secstore) format.* -[sec2]: http://www.secg.org/sec2-v2.pdf +[sec2]: https://www.secg.org/sec2-v2.pdf [accounts-go]: https://godoc.org/github.com/ethereum/go-ethereum/accounts [secp256k1]: https://github.com/bitcoin-core/secp256k1 [secstore]: https://github.com/ethereum/wiki/wiki/Web3-Secret-Storage-Definition diff --git a/docs/_dapp/native-accounts.md b/docs/_dapp/native-accounts.md index 4458ed948d..37b7288f2e 100644 --- a/docs/_dapp/native-accounts.md +++ b/docs/_dapp/native-accounts.md @@ -45,7 +45,7 @@ environments. *For those interested in the cryptographic and/or implementation details, the key-store uses the `secp256k1` elliptic curve as defined in the [Standards for Efficient -Cryptography](http://www.secg.org/sec2-v2.pdf), implemented by the [`libsecp256k`](https://github.com/bitcoin-core/secp256k1) library and wrapped by +Cryptography](https://www.secg.org/sec2-v2.pdf), implemented by the [`libsecp256k`](https://github.com/bitcoin-core/secp256k1) library and wrapped by [`github.com/ethereum/go-ethereum/accounts`](https://godoc.org/github.com/ethereum/go-ethereum/accounts). Accounts are stored on disk in the [Web3 Secret Storage](https://github.com/ethereum/wiki/wiki/Web3-Secret-Storage-Definition) format.* diff --git a/docs/_getting-started/dev-mode.md b/docs/_getting-started/dev-mode.md index 2681ee320d..0ca39ccf5b 100644 --- a/docs/_getting-started/dev-mode.md +++ b/docs/_getting-started/dev-mode.md @@ -58,4 +58,7 @@ If you want to test your dapps with a realistic block time use the `--dev.period ## Connect Remix to Geth -With geth now running, open . Compile the contract as normal, but when you deploy and run a contract, select _Web3 Provider_ from the _Environment_ dropdown, and add "http://127.0.0.1:8545" to the popup box. Click _Deploy_, and interact with the contract. You should see contract creation, mining, and transaction activity. \ No newline at end of file +With geth now running, open . Compile the contract as normal, +but when you deploy and run a contract, select _Web3 Provider_ from the _Environment_ +dropdown, and add "http://127.0.0.1:8545" to the popup box. Click _Deploy_, and interact +with the contract. You should see contract creation, mining, and transaction activity. diff --git a/docs/_install-and-build/Installing-Geth.md b/docs/_install-and-build/Installing-Geth.md index d6a25cfbce..ede81ab975 100644 --- a/docs/_install-and-build/Installing-Geth.md +++ b/docs/_install-and-build/Installing-Geth.md @@ -19,7 +19,7 @@ Geth will automatically use the data of your old node and sync the latest blocks ### Install on macOS via Homebrew The easiest way to install go-ethereum is to use our -Homebrew tap. If you don't have Homebrew, [install it first](http://brew.sh). +Homebrew tap. If you don't have Homebrew, [install it first](https://brew.sh). Run the following commands to add the tap and install `geth`: diff --git a/docs/_interface/FAQ.md b/docs/_interface/FAQ.md index 51cbbc638a..741827df16 100644 --- a/docs/_interface/FAQ.md +++ b/docs/_interface/FAQ.md @@ -6,7 +6,7 @@ sort_key: C **Q.** I noticed my peercount slowly decrease, and now it is at 0. Restarting doesn't get any peers. -**A.** Check and sync your clock with ntp. [Example](http://askubuntu.com/questions/254826/how-to-force-a-clock-update-using-ntp) `sudo ntpdate -s time.nist.gov` +**A.** Check and sync your clock with ntp. [Example](https://askubuntu.com/questions/254826/how-to-force-a-clock-update-using-ntp) `sudo ntpdate -s time.nist.gov` --- diff --git a/docs/_interface/mining.md b/docs/_interface/mining.md index d0371dc371..2b041e3b73 100644 --- a/docs/_interface/mining.md +++ b/docs/_interface/mining.md @@ -4,7 +4,7 @@ sort_key: B --- This document explains how to set up geth for mining. The Ethereum wiki also has a [page -about mining](eth-wiki-mining), be sure to check that one as well. +about mining](https://eth.wiki/en/fundamentals/mining), be sure to check that one as well. Mining is the process through which new blocks are created. Geth actually creates new blocks all the time, but these blocks need to be secured through proof-of-work so they @@ -13,7 +13,7 @@ will be accepted by other nodes. Mining is all about creating these proof-of-wor The proof-of-work computation can be performed in multiple ways. Geth includes a CPU miner, which does mining within the geth process. We discourage using the CPU miner with the Ethereum mainnet. If you want to mine real ether, use GPU mining. Your best option for -doing that is the [ethminer](ethminer) software. +doing that is the [ethminer](https://github.com/ethereum-mining/ethminer) software. Always ensure your blockchain is fully synchronised with the chain before starting to mine, otherwise you will not be mining on the correct chain and your block rewards will @@ -52,7 +52,7 @@ Now we're ready to start mining. In a new terminal session, run ethminer and con ethminer -G -P http://127.0.0.1:8545 `ethminer` communicates with geth on port 8545 (the default RPC port in geth). You can -change this by giving the [`--rpcport` option](../rpc/index) to `geth`. Ethminer will find +change this by giving the [`--rpcport` option](../rpc/server) to `geth`. Ethminer will find get on any port. You also need to set the port on `ethminer` with `-P http://127.0.0.1:3301`. Setting up custom ports is necessary if you want several instances mining on the same computer. If you are testing on a private cluster, we recommend you use diff --git a/docs/_interface/peer-to-peer.md b/docs/_interface/peer-to-peer.md index deac4d5b53..ba38939f41 100644 --- a/docs/_interface/peer-to-peer.md +++ b/docs/_interface/peer-to-peer.md @@ -147,7 +147,7 @@ static nodes by putting something like the following into ``` You can also add static nodes at runtime via the js console using -[`admin.addPeer()`](../interface/management-apis#admin_addpeer): +`admin.addPeer()`: ```js admin.addPeer("enode://f4642fa65af50cfdea8fa7414a5def7bb7991478b768e296f5e4a54e8b995de102e0ceae2e826f293c481b5325f89be6d207b003382e18a8ecba66fbaf6416c0@33.4.2.1:30303") diff --git a/docs/_legacy/Contract-Tutorial.md b/docs/_legacy/Contract-Tutorial.md index c1128a1537..00a10308af 100644 --- a/docs/_legacy/Contract-Tutorial.md +++ b/docs/_legacy/Contract-Tutorial.md @@ -82,7 +82,7 @@ Take note of the path given by the last line, you'll need it soon. #### Install SolC on Mac OSX -You need [brew](http://brew.sh) in order to install on your mac +You need [brew](https://brew.sh) in order to install on your mac brew tap ethereum/ethereum brew install solidity diff --git a/docs/_rpc/ns-admin.md b/docs/_rpc/ns-admin.md index 6727913ff4..189ca0b9db 100644 --- a/docs/_rpc/ns-admin.md +++ b/docs/_rpc/ns-admin.md @@ -143,7 +143,7 @@ protocols (e.g. `eth`, `les`, `shh`, `bzz`). ### admin_startRPC -The `startRPC` administrative method starts an HTTP based [JSON RPC](http://www.jsonrpc.org/specification) +The `startRPC` administrative method starts an HTTP based [JSON RPC](https://www.jsonrpc.org/specification) API webserver to handle client requests. All the parameters are optional: * `host`: network interface to open the listener socket on (defaults to `"localhost"`) @@ -168,7 +168,7 @@ true ### admin_startWS -The `startWS` administrative method starts an WebSocket based [JSON RPC](http://www.jsonrpc.org/specification) +The `startWS` administrative method starts an WebSocket based [JSON RPC](https://www.jsonrpc.org/specification) API webserver to handle client requests. All the parameters are optional: * `host`: network interface to open the listener socket on (defaults to `"localhost"`) diff --git a/docs/_rpc/ns-debug.md b/docs/_rpc/ns-debug.md index e7d92fc625..a59b6a960d 100644 --- a/docs/_rpc/ns-debug.md +++ b/docs/_rpc/ns-debug.md @@ -156,7 +156,7 @@ destructive action and may severely damage your chain. Use with *extreme* cautio | RPC | `{"method": "debug_setHead", "params": [number]}` | References: -[Ethash](https://github.com/ethereum/wiki/wiki/Mining#the-algorithm) +[Ethash](https://eth.wiki/en/concepts/ethash/ethash) ### debug_setBlockProfileRate diff --git a/index.html b/index.html index bbcfc6dac0..3374e1f986 100644 --- a/index.html +++ b/index.html @@ -10,7 +10,7 @@ css:

Official Go implementation of the Ethereum protocol


View on GitHub - Chat on Discord + Chat on Discord diff --git a/redirects/dev-mode.md b/redirects/dev-mode.md new file mode 100644 index 0000000000..b0c7413a60 --- /dev/null +++ b/redirects/dev-mode.md @@ -0,0 +1,7 @@ +--- +# This page exists because we used to have the 'getting started' pages +# under /getting-started/... instead of /docs/getting-started/... +permalink: /getting-started/dev-mode +new_url: /docs/getting-started/dev-mode +layout: redirect +--- diff --git a/redirects/private-net.md b/redirects/private-net.md new file mode 100644 index 0000000000..c5b2cd3f0d --- /dev/null +++ b/redirects/private-net.md @@ -0,0 +1,7 @@ +--- +# This page exists because we used to have the 'getting started' pages +# under /getting-started/... instead of /docs/getting-started/... +permalink: /getting-started/private-net +new_url: /docs/getting-started/private-net +layout: redirect +---