gaspersic/go-ethereum
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Move all documentation below /docs (#20072)

Browse Source 
* 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
This commit is contained in:
Adam Schmideg
2019-10-01 10:40:09 +02:00
committed by Felix Lange
parent 8dc979183f
commit 8e49d1571d
28 changed files with 85 additions and 71 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/_install-and-build/Backup--restore.md
View File

@ -23,9 +23,9 @@ The default data directory locations are platform specific:
Accounts are stored in the `keystore` subdirectory. The contents of this directories should be transportable between nodes, platforms, implementations (C++, Go, Python).
To configure the location of the data directory, the `--datadir` parameter can be specified. See [CLI Options](../interface/Command-Line-Options) for more details.
To configure the location of the data directory, the `--datadir` parameter can be specified. See [CLI Options](../interface/command-line-options) for more details.
_**Note:** The [Ethash DAG](../how-to/Mining#ethash-dag) is stored at `~/.ethash` (Mac/Linux) or `%APPDATA%\Ethash` (Windows) so that it can be reused by all clients. You can store this in a different location by using a symbolic link._
_**note:** the [ethash dag](../legacy/mining#ethash-dag) is stored at `~/.ethash` (Mac/Linux) or `%APPDATA%\Ethash` (Windows) so that it can be reused by all clients. You can store this in a different location by using a symbolic link._
## Upgrades

5
docs/_install-and-build/Build-from-Source.md
View File

@ -1,7 +1,8 @@
---
title: Build from source
---
<!-- TODO: Maybe move? -->
## Build from source
Go Ethereum (as its name implies) is written in [Go](https://golang.org), and as such to build from source code you need to have at least Go 1.7 installed (preferably the latest version, currently at 1.9.2). This guide does not go into details on how to install Go itself, for that please read the [Go installation instructions](https://golang.org/doc/install).
Assuming you have Go installed, you can download our project via:

14
docs/_install-and-build/Developers-Guide.md
View File

@ -2,7 +2,7 @@
title: Developers' guide
---
**NOTE: These instructions are for people who want to contribute Go source code changes.
If you just want to run ethereum, use the normal [Installation Instructions](Installing-Geth)**
If you just want to run ethereum, use the normal [Installation Instructions](installing-geth)**
This document is the entry point for developers of the Go implementation of Ethereum. Developers here refer to the hands-on: who are interested in build, develop, debug, submit a bug report or pull request or contribute code to go-ethereum.
@ -49,7 +49,7 @@ go-ethereum exectuables can be built individually. To build just geth, use:
go install -v ./cmd/geth
```
Read about cross compilation of go-ethereum [here](../doc/Cross-compiling-Ethereum).
read about cross compilation of go-ethereum [here](../developers/cross-compiling-ethereum).
### Git flow
@ -84,7 +84,7 @@ for more see [go test flags](http://golang.org/cmd/go/#hdr-Description_of_testin
### Metrics and monitoring
`geth` can do node behaviour monitoring, aggregation and show performance metric charts.
Read about [metrics and monitoring](../doc/Metrics-and-Monitoring)
read about [metrics and monitoring](../doc/metrics-and-monitoring)
### Getting Stack Traces
@ -126,7 +126,7 @@ PRs need to be based on and opened against the `master` branch (unless by explic
agreement, you contribute to a complex feature branch).
Your PR will be reviewed according to the [Code Review
Guidelines](../doc/Code-Review-Guidelines).
guidelines](../developers/code-review-guidelines).
We encourage a PR early approach, meaning you create the PR the earliest even without the
fix/feature. This will let core devs and other volunteers know you picked up an issue.
@ -134,8 +134,8 @@ These early PRs should indicate 'in progress' status.
## Dev Tutorials (mostly outdated)
* [Private networks, local clusters and monitoring](../doc/Setting-up-private-network-or-local-cluster)
* [private networks, local clusters and monitoring](../doc/setting-up-private-network-or-local-cluster)
* [P2P 101](../doc/Peer-to-Peer): a tutorial about setting up and creating a p2p server and p2p sub protocol.
* [p2p 101](../developers/peer-to-peer): a tutorial about setting up and creating a p2p server and p2p sub protocol.
* [How to Whisper](../doc/How-to-Whisper): an introduction to whisper.
* [how to whisper](../whisper/whisper-overview): an introduction to whisper.