docs: move some pages (#169)

Moves a few pages to new locations based on feedback from Geth team.

Co-authored-by: Felix Lange <fjl@twurst.com>
pull/26459/head^2
Joseph Cook 2 years ago committed by GitHub
parent 77d4a92374
commit 0051501bc5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 0
      docs/developers/dapp-developer/dev-mode.md
  2. 0
      docs/developers/geth-developer/contributing.md
  3. 62
      docs/developers/geth-developer/issue-handling-workflow.md
  4. 0
      docs/fundamentals/private-network.md
  5. 10
      src/data/documentation-links.yaml
  6. 8
      url-list.csv

@ -1,62 +0,0 @@
---
title: Issue Handling Workflow
description: Instructions for managing GitHub issues
---
## Draft proposal {#draft-proposal}
- Keep the number of open issues under 820
- Keep the ratio of open issues per all issues under 13%
- Have 50 issues labelled [help wanted](https://github.com/ethereum/go-ethereum/labels/help%20wanted) and 50 [good first issue](https://github.com/ethereum/go-ethereum/labels/good%20first%20issue).
- Use structured labels of the form `<category>:<label>` or if need be `<category>:<main>/<sub>`, for example `area: plugins/foobuzzer`.
- Use the following labels. Areas and statuses depend on the application and workflow.
* area
- `area: android`
- `area: clef`
- `area: network`
- `area: swarm`
- `area: whisper`
* type
- `type: bug`
- `type: feature`
- `type: documentation`
- `type: discussion`
* status
- `status: PR review`
- `status: community working on it`
* need
- `need: more info`
- `need: steps to reproduce`
- `need: investigation`
- `need: decision`
Use these milestones
- [Future](https://github.com/ethereum/go-ethereum/milestone/80) - Maybe implement one day
- [Coming soon](https://github.com/ethereum/go-ethereum/milestone/81) - Not assigned to a specific release, but to be delivered in one of the upcoming releases
- \<next version\> - Next release with a version number
- \<next-next version\> - The version after the next release with a version number
- \<next major release\> - Optional.
It's ok to not set a due date for a milestone, but once you release it, close it. If you have a few issues dangling, consider moving them to the next milestone, and close this one.
Optionally, use a project board to collect issues of a larger effort that has an end state and overarches multiple releases.
## Workflow {#workflow}
The Geth core team hold a weekly or bi-weekly triage meeting. Issues are preselected by [labelling them "status:triage" and sorted the oldest ones first](https://github.com/ethereum/go-ethereum/issues?q=is%3Aopen+is%3Aissue+label%3Astatus%3Atriage+sort%3Acreated-asc). This is when the team goes through the new issues and do one of the following
1. Close it.
2. Assign it to "Coming soon" milestone which doesn't have an end date.
3. Move it to the "Future" milestone.
4. Change its status to "Need:\<what-is-needed\>".
Optional further activities:
- Label the issue with the appropriate area/component.
- Add a section to the FAQ or add a wiki page. Link to it from the issue.

@ -30,6 +30,8 @@
to: /docs/fundamentals/peer-to-peer
- id: Pruning
to: /docs/fundamentals/pruning
- id: Private networks
to: /docs/fundamentals/private-network
- id: Light client
to: /docs/fundamentals/les
- id: Mining
@ -78,6 +80,8 @@
to: /docs/developers
- id: Dapp developers
items:
- id: Dev mode
to: /docs/developers/dapp-developer/dev-mode
- id: Go API
to: /docs/developers/dapp-developer/native
- id: Go Account Management
@ -102,18 +106,12 @@
items:
- id: Developer guide
to: /docs/developers/geth-developer/dev-guide
- id: Developer mode
to: /docs/developers/geth-developer/dev-mode
- id: Disclosures
to: /docs/developers/geth-developer/disclosures
- id: Issue handling workflow
to: /docs/developers/geth-developer/issue-handling-workflow
- id: DNS discovery setup guide
to: /docs/developers/geth-developer/dns-discovery-setup
- id: Code review guidelines
to: /docs/developers/geth-developer/code-review-guidelines
- id: Private networks
to: /docs/developers/geth-developer/private-network
- id: Contributing
to: /docs/developers/contributing
- id: Monitoring

@ -3,7 +3,7 @@ https://geth.ethereum.org/,https://geth.ethereum.org,,will be react page
https://geth.ethereum.org/downloads/,https://geth.ethereum.org/downloads,,will be react page
https://geth.ethereum.org/docs/,https://geth.ethereum.org/docs,,n/a
https://geth.ethereum.org/docs/getting-started,https://geth.ethereum.org/docs/getting-started/backup-restore,,n/a
https://geth.ethereum.org/docs/getting-started/dev-mode,https://geth.ethereum.org/docs/developers/geth-developer/dev-mode,,n/a
https://geth.ethereum.org/docs/getting-started/dev-mode,https://geth.ethereum.org/docs/developers/dapp-developer/dev-mode,,n/a
https://geth.ethereum.org/docs/install-and-build/installing-geth,https://geth.ethereum.org/docs/getting-started/install-geth,,n/a
https://geth.ethereum.org/docs/install-and-build/backup-restore,https://geth.ethereum.org/docs/getting-started/backup-restore,,n/a
https://geth.ethereum.org/docs/interface/command-line-options,https://geth.ethereum.org/docs/fundamentals/command-line-options,,n/a
@ -14,7 +14,7 @@ https://geth.ethereum.org/docs/interface/les,https://geth.ethereum.org/docs/fund
https://geth.ethereum.org/docs/interface/managing-your-accounts,https://geth.ethereum.org/docs/fundamentals/account-management,,n/a
https://geth.ethereum.org/docs/faq,https://geth.ethereum.org/docs/faq,,n/a
https://geth.ethereum.org/docs/interface/javascript-console,https://geth.ethereum.org/docs/interacting-with-geth/javascript-console,,n/a
https://geth.ethereum.org/docs/interface/private-network,https://geth.ethereum.org/docs/developers/geth-developer/private-network,,n/a
https://geth.ethereum.org/docs/interface/private-network,https://geth.ethereum.org/docs/fundamentals/private-network,,n/a
https://geth.ethereum.org/docs/interface/mining,https://geth.ethereum.org/docs/fundamentals/mining,,n/a
https://geth.ethereum.org/docs/interface/metrics,https://geth.ethereum.org/docs/monitoring/metrics,,n/a
https://geth.ethereum.org/docs/dapp/native,https://geth.ethereum.org/docs/developers/dapp-developer/native,,n/a
@ -41,7 +41,7 @@ https://geth.ethereum.org/docs/rpc/ns-txpool,https://geth.ethereum.org/docs/inte
https://geth.ethereum.org/docs/rpc/objects,https://geth.ethereum.org/docs/interacting-with-geth/rpc/objects,,n/a
https://geth.ethereum.org/docs/developers/dev-guide,https://geth.ethereum.org/docs/developers/geth-developer/dev-guide,,n/a
https://geth.ethereum.org/docs/developers/code-review-guidelines,https://geth.ethereum.org/docs/developers/geth-developer/code-review-guidelines,,n/a
https://geth.ethereum.org/docs/developers/issue-handling-workflow,https://geth.ethereum.org/docs/developers/geth-developer/issue-handling-workflow,,n/a
https://geth.ethereum.org/docs/developers/issue-handling-workflow,https://geth.ethereum.org/,page deleted,n/a
https://geth.ethereum.org/docs/developers/dns-discovery-setup,https://geth.ethereum.org/doce/developers/geth-developer/dns-discovery-setup,,n/a
https://geth.ethereum.org/docs/clef/introduction,https://geth.ethereum.org/docs/tools/clef/introduction,,n/a
https://geth.ethereum.org/docs/clef/tutorial,https://geth.ethereum.org/docs/tools/clef/tutorial,,n/a
@ -54,4 +54,4 @@ https://geth.ethereum.org/docs/interface/sync-modes,https://geth.ethereum.org/do
https://geth.ethereum.org/docs/interface/hardware,https://geth.ethereum.org/docs/getting-started/hardware-requirements,,
https://github.com/ethereum/go-ethereum/tree/gh-pages/docs/_vulnerabilities/vulnerabilities.json,https://github.com/ethereum/go-ethereum/tree/gh-pages/docs/_vulnerabilities/vulnerabilities.json,"Cant add redirect since this is a external URL (GitHub, not geth.ethereum.org)",must be served at original URL
https://github.com/ethereum/go-ethereum/tree/gh-pages/docs/_vulnerabilities/vulnerabilities.json.minisig,https://github.com/ethereum/go-ethereum/tree/gh-pages/docs/_vulnerabilities/vulnerabilities.json.minisig,"Cant add redirect since this is a external URL (GitHub, not geth.ethereum.org)",must be served at original URL
https://github.com/ethereum/go-ethereum/tree/gh-pages/docs/_vulnerabilities/vulnerabilities.md,https://geth.ethereum.org/docs/developers/geth-developer/disclosures,"Cant add redirect since this is a external URL (GitHub, not geth.ethereum.org)",moved to /docs and renamed
https://github.com/ethereum/go-ethereum/tree/gh-pages/docs/_vulnerabilities/vulnerabilities.md,https://geth.ethereum.org/docs/developers/geth-developer/disclosures,"Cant add redirect since this is a external URL (GitHub, not geth.ethereum.org)",moved to /docs and renamed

1 OLD Geth website URLS Equivalent NEW website URLs Notes
3 https://geth.ethereum.org/downloads/ https://geth.ethereum.org/downloads will be react page
4 https://geth.ethereum.org/docs/ https://geth.ethereum.org/docs n/a
5 https://geth.ethereum.org/docs/getting-started https://geth.ethereum.org/docs/getting-started/backup-restore n/a
6 https://geth.ethereum.org/docs/getting-started/dev-mode https://geth.ethereum.org/docs/developers/geth-developer/dev-mode https://geth.ethereum.org/docs/developers/dapp-developer/dev-mode n/a
7 https://geth.ethereum.org/docs/install-and-build/installing-geth https://geth.ethereum.org/docs/getting-started/install-geth n/a
8 https://geth.ethereum.org/docs/install-and-build/backup-restore https://geth.ethereum.org/docs/getting-started/backup-restore n/a
9 https://geth.ethereum.org/docs/interface/command-line-options https://geth.ethereum.org/docs/fundamentals/command-line-options n/a
14 https://geth.ethereum.org/docs/interface/managing-your-accounts https://geth.ethereum.org/docs/fundamentals/account-management n/a
15 https://geth.ethereum.org/docs/faq https://geth.ethereum.org/docs/faq n/a
16 https://geth.ethereum.org/docs/interface/javascript-console https://geth.ethereum.org/docs/interacting-with-geth/javascript-console n/a
17 https://geth.ethereum.org/docs/interface/private-network https://geth.ethereum.org/docs/developers/geth-developer/private-network https://geth.ethereum.org/docs/fundamentals/private-network n/a
18 https://geth.ethereum.org/docs/interface/mining https://geth.ethereum.org/docs/fundamentals/mining n/a
19 https://geth.ethereum.org/docs/interface/metrics https://geth.ethereum.org/docs/monitoring/metrics n/a
20 https://geth.ethereum.org/docs/dapp/native https://geth.ethereum.org/docs/developers/dapp-developer/native n/a
41 https://geth.ethereum.org/docs/rpc/objects https://geth.ethereum.org/docs/interacting-with-geth/rpc/objects n/a
42 https://geth.ethereum.org/docs/developers/dev-guide https://geth.ethereum.org/docs/developers/geth-developer/dev-guide n/a
43 https://geth.ethereum.org/docs/developers/code-review-guidelines https://geth.ethereum.org/docs/developers/geth-developer/code-review-guidelines n/a
44 https://geth.ethereum.org/docs/developers/issue-handling-workflow https://geth.ethereum.org/docs/developers/geth-developer/issue-handling-workflow https://geth.ethereum.org/ page deleted n/a
45 https://geth.ethereum.org/docs/developers/dns-discovery-setup https://geth.ethereum.org/doce/developers/geth-developer/dns-discovery-setup n/a
46 https://geth.ethereum.org/docs/clef/introduction https://geth.ethereum.org/docs/tools/clef/introduction n/a
47 https://geth.ethereum.org/docs/clef/tutorial https://geth.ethereum.org/docs/tools/clef/tutorial n/a
54 https://geth.ethereum.org/docs/interface/hardware https://geth.ethereum.org/docs/getting-started/hardware-requirements
55 https://github.com/ethereum/go-ethereum/tree/gh-pages/docs/_vulnerabilities/vulnerabilities.json https://github.com/ethereum/go-ethereum/tree/gh-pages/docs/_vulnerabilities/vulnerabilities.json Cant add redirect since this is a external URL (GitHub, not geth.ethereum.org) must be served at original URL
56 https://github.com/ethereum/go-ethereum/tree/gh-pages/docs/_vulnerabilities/vulnerabilities.json.minisig https://github.com/ethereum/go-ethereum/tree/gh-pages/docs/_vulnerabilities/vulnerabilities.json.minisig Cant add redirect since this is a external URL (GitHub, not geth.ethereum.org) must be served at original URL
57 https://github.com/ethereum/go-ethereum/tree/gh-pages/docs/_vulnerabilities/vulnerabilities.md https://geth.ethereum.org/docs/developers/geth-developer/disclosures Cant add redirect since this is a external URL (GitHub, not geth.ethereum.org) moved to /docs and renamed
Loading…
Cancel
Save