From 42ec66dbbb5ac9c7ab2f37e6ab86d528bc03a83e Mon Sep 17 00:00:00 2001 From: Eric Kellstrand <34311165+ekellstrand@users.noreply.github.com> Date: Fri, 12 Oct 2018 11:35:38 -0400 Subject: [PATCH] [NC-1540] First Draft of OSS Roles & Std OSS Documenation (#53) [NC-1699] Fill in download badge links once artifacts exist on bintray --- .github/pull_request_template.md | 6 ++++-- CONTRIBUTING.md | 10 +++++----- README.md | 24 +++++++++++++++--------- 3 files changed, 24 insertions(+), 16 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 6383355cd2..cef0ec48a1 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,6 +1,8 @@ # PR Details diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 53ae4f7401..83a26930e3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -43,7 +43,7 @@ This project and everyone participating in it is governed by the [Pantheon Code This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report :pencil:, reproduce the behavior :computer: :computer:, and find related reports :mag_right:. -Before creating bug reports, please check the [before-submitting-a-bug-report](#before-submitting-a-bug-report) checklist as you might find out that you don't need to create one. When you are creating a bug report, please [include as many details as possible](#how-do-i-submit-a-good-bug-report). Fill in the [ISSUE-TEMPLATE.md](.github/issue_template.md), the information it asks for helps us resolve issues faster. +Before creating bug reports, please check the [before-submitting-a-bug-report](#before-submitting-a-bug-report) checklist as you might find out that you don't need to create one. When you are creating a bug report, please [include as many details as possible](#how-do-i-submit-a-good-bug-report). Fill in the [issue_template.md](.github/issue_template.md), the information it asks for helps us resolve issues faster. > **Note:** If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one. @@ -53,7 +53,7 @@ Before creating bug reports, please check the [before-submitting-a-bug-report](# * **Perform a [cursory search of project issues](https://github.com/search?q=+is%3Aissue+repo%3APegasysEng/Pantheon)** to see if the problem has already been reported. If it has **and the issue is still open**, add a comment to the existing issue instead of opening a new one. #### How Do I Submit A (Good) Bug Report? -Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). Issues should and provide the following information by filling in the [ISSUE-TEMPLATE.md](.github/issue_template.md). +Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). Issues should and provide the following information by filling in the [issue_template.md](.github/issue_template.md). Explain the problem and include additional details to help maintainers reproduce the problem: @@ -84,7 +84,7 @@ Include details about your configuration and environment: This section guides you through submitting an enhancement suggestion, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion :pencil: and find related suggestions :mag_right:. -Before creating enhancement suggestions, please check the [before-submitting-an-enhancement-suggestion](#before-submitting-an-enhancement-suggestion) list as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please [include as many details as possible](#how-do-i-submit-a-good-enhancement-suggestion). Fill in the [ISSUE-TEMPLATE.md](.github/issue_template.md), including the steps that you imagine you would take if the feature you're requesting existed. +Before creating enhancement suggestions, please check the [before-submitting-an-enhancement-suggestion](#before-submitting-an-enhancement-suggestion) list as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please [include as many details as possible](#how-do-i-submit-a-good-enhancement-suggestion). Fill in the [issue_template.md](.github/issue_template.md), including the steps that you imagine you would take if the feature you're requesting existed. #### Before Submitting An Enhancement Suggestion @@ -93,7 +93,7 @@ Before creating enhancement suggestions, please check the [before-submitting-an- #### How Do I Submit A (Good) Enhancement Suggestion? -Enhancement suggestions are tracked as [GitHub issues](https://guides.github.com/features/issues/). Issues should and provide the following information by filling in the [ISSUE-TEMPLATE.md](.github/issue_template.md) and providing the following information: +Enhancement suggestions are tracked as [GitHub issues](https://guides.github.com/features/issues/). Issues should and provide the following information by filling in the [issue_template.md](.github/issue_template.md) and providing the following information: * **Use a clear and descriptive title** for the issue to identify the suggestion. * **Provide a step-by-step description of the suggested enhancement** in as many details as possible. @@ -276,4 +276,4 @@ Please open an issue on `PegasysEng/Pantheon` if you have suggestions for new la [Wiki]: https://github.com/PegaSysEng/pantheon/wiki [Debugging Wiki]: https://github.com/PegaSysEng/pantheon/wiki/Debugging [CLA.md]: /CLA.md -[code-reviews.md]: /docs/community/code-reviews.md \ No newline at end of file +[Code Reviews]: /docs/community/code-reviews.md \ No newline at end of file diff --git a/README.md b/README.md index 8d629b34f1..20d761bfbb 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Pantheon Ethereum Client [![Build Status](http://forge-jenkins.kellstrand.com:8080/job/PegaSysEng%20Pantheon/job/master/badge/icon)](http://forge-jenkins.kellstrand.com:8080/job/PegaSysEng%20Pantheon/job/master/) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/PegasysEng/pantheon/blob/master/LICENSE) - [![Download](https://api.bintray.com/packages/consensys/binaries/pantheon/images/download.svg)](https://bintray.com/consensys/binaries/pantheon/_latestVersion) + [ ![Download](https://api.bintray.com/packages/consensys/pegasys-repo/pantheon/images/download.svg) ](https://bintray.com/consensys/pegasys-repo/pantheon/_latestVersion) TODO: Update Download links once artifacts are on bintray @@ -12,29 +12,35 @@ The process for building and running Pantheon as a user is different to when dev ### Build, Install, and Run Pantheon Building, installing, and running Pantheon is described in the Wiki: -* [Build and Install](https://github.com/PegaSysEng/pantheon/wiki/Installation) -* [Quickstart](https://github.com/PegaSysEng/pantheon/wiki/Quickstart) +* [Installation Wiki] +* [Quickstart Wiki] ### Documentation User and reference documentation available on the Wiki includes: -* [Command Line Options](https://github.com/PegaSysEng/pantheon/wiki/Pantheon-CLI-Syntax) -* [JSON-RPC API](https://github.com/PegaSysEng/pantheon/wiki/JSON-RPC-API) -* [Docker Quickstart Tutorial](https://github.com/PegaSysEng/pantheon/wiki/Docker-Quickstart) +* [Command Line Options] +* [JSON-RPC API] +* [Docker Quickstart Tutorial] ## Pantheon Developers * [Contribution Guidelines](CONTRIBUTING.md) -* [Wiki](wiki/) for installation & configuring Pantheon -* [Installation](wiki/Installation) +* [Wiki] for installation & configuring Pantheon +* [Installation Wiki] ### Development Instructions for how to get started with developing on the Orion codebase. Please also read the [contribution guidelines](CONTRIBUTING.md) for more detail on how to submit a pull request (PR). -* [Installation](wiki/Installation) +* [Installation Wiki] * [Checking out and building](docs/development/building.md) * [Running Pantheon via Gradle](docs/development/running-with-gradle.md) * [Code Coverage](docs/development/code-coverage.md) * [Logging](docs/development/logging.md) +[Wiki]: https://github.com/PegaSysEng/pantheon/wiki +[Installation Wiki]: https://github.com/PegaSysEng/pantheon/wiki/Installation +[Quickstart Wiki]: https://github.com/PegaSysEng/pantheon/wiki/Quickstart +[Docker Quickstart Tutorial]: https://github.com/PegaSysEng/pantheon/wiki/Docker-Quickstart +[Command Line Options]: https://github.com/PegaSysEng/pantheon/wiki/Pantheon-CLI-Syntax +[JSON-RPC API]: https://github.com/PegaSysEng/pantheon/wiki/JSON-RPC-API