Skip to content

Commit

Permalink
BE-111 Update Hyperledger Explorer documentation
Browse files Browse the repository at this point in the history
Signed-off-by: nfrunza <nfrunza@gmail.com>
Change-Id: I2be39b596a27fa70953e18780430b84bb097d05a
  • Loading branch information
nfrunza committed Jun 25, 2019
1 parent fe002ce commit 4ed8706
Show file tree
Hide file tree
Showing 10 changed files with 148 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@

<!-- (SPDX-License-Identifier: CC-BY-4.0) --> <!-- Ensure there is a newline before, and after, this line -->

## Hyperledger Explorer

- [Project Lifecycle](project_lifecycle/README.md)
- [Hyperledger Explorer functionalities](project_functionalities/README.md)



9 changes: 9 additions & 0 deletions docs/project_functionalities/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@

<!-- (SPDX-License-Identifier: CC-BY-4.0) --> <!-- Ensure there is a newline before, and after, this line -->

## Hyperledger Explorer functionalities

- Hyperledger Explorer



69 changes: 69 additions & 0 deletions docs/project_lifecycle/Incubation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
<!-- (SPDX-License-Identifier: CC-BY-4.0) --> <!-- Ensure there is a newline before, and after, this line -->

## Incubation


### Minimum requirements
- Legal

- All code has been made available under the Apache License and is free of incompatible dependencies

- [License scans, and audits](https://wiki.hyperledger.org/display/explorer/Audits)

- Project name has been checked for trademark issues

- Hyperledger Explorer

- Hyperledger Explorer follows [Hyperledger Trademark Usage Guidelines](https://www.hyperledger.org/trademark-usage)

- Community support

- The project has active and diverse set of contributing members representing various constituencies

- [Contributors](https://github.com/hyperledger/blockchain-explorer/blob/master/MAINTAINERS.rst)

- Hyperledger Explorer project is not highly dependent on any single contributor, current contributors are from DTCC, and Fujitsu.

- Release plans are developed and executed in public by the community, the latest tag is v0.3.9.4.

- Sufficient test coverage

- The project include a comprehensive unit and integration test suite configured at:
[Selenium test](https://github.com/hyperledger/blockchain-explorer/blob/master/client/e2e-setup.sh), and
[BDD test](https://github.com/hyperledger/blockchain-explorer/tree/master/app/platform/fabric/e2e-test) and are triggered during the CI/CD builds.
- Code coverage is setup in both [frontend](https://github.com/hyperledger/blockchain-explorer/blob/master/client/package.json#L58) and [back-end](https://github.com/hyperledger/blockchain-explorer/blob/master/app/test/package.json#L24).

- [Coverage report example](https://jenkins.hyperledger.org/job/blockchain-explorer-merge-x86_64/125/Code_20Coverage_20Report/) available after each Jenkins build.

- Sufficient user documentation

- [User documentation](https://github.com/hyperledger/blockchain-explorer/blob/master/README.md)


## Infrastructure

- Gerrit or Github repo has been created

- [Team code collaboration tool](https://gerrit.hyperledger.org/r/c/blockchain-explorer/+/31990)
- [Hyperledger Explorer Repository](https://github.com/hyperledger/blockchain-explorer)

- Mailing lists have been created and are archived

- [Mailing list](https://lists.hyperledger.org/g/explorer)

- Other communication means used, such as slack channels, are set up

- Hyperledger Explorer [wiki](https://wiki.hyperledger.org/display/explorer/Hyperledger+Explorer)
- [Rochet chat hyperledger-explorer](https://chat.hyperledger.org/channel/hyperledger-explorer)
- [Rochet chat developer channel](https://chat.hyperledger.org/channel/hlexplorer-developers)

## Continuous Integration

- [CI/CD](https://jenkins.hyperledger.org/view/blockchain-explorer/)
- [CONTRIBUTING.md](https://github.com/hyperledger/blockchain-explorer/blob/master/CONTRIBUTING.md)
- [MAINTAINERS.rst](https://github.com/hyperledger/blockchain-explorer/blob/master/MAINTAINERS.rst)

## CII Badge

- [Core Infrastructure Initiative (CII) badge](https://bestpractices.coreinfrastructure.org/en/projects/2710)

21 changes: 21 additions & 0 deletions docs/project_lifecycle/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@

<!-- (SPDX-License-Identifier: CC-BY-4.0) --> <!-- Ensure there is a newline before, and after, this line -->

## Hyperledger Explorewr Project Lifecycle

- Hyperledger Explorer Project follows the Hyperledger Project lifecycle states process as follows:

- [Proposal](proposal.md)

- [Incubation](incubation.md)

- [Active](active.md)

- [First Major Release](first-major-release.md)

- [Deprecated](deprecated.md)

- [End of Life](end-of-life.md)

Projects may not necessarily move through those states in a linear way and may go through several iterations.

6 changes: 6 additions & 0 deletions docs/project_lifecycle/active.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<!-- (SPDX-License-Identifier: CC-BY-4.0) --> <!-- Ensure there is a newline before, and after, this line -->

## Active

- Hyperledger Explorer is in the Incubation phase

6 changes: 6 additions & 0 deletions docs/project_lifecycle/deprecated.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<!-- (SPDX-License-Identifier: CC-BY-4.0) --> <!-- Ensure there is a newline before, and after, this line -->

## Deprecated

- A Deprecated project will be maintained for a six month period by its community, after which it will be removed from any subsequent formal releases. Notice will be given to the public of the project’s deprecation. After the six-month deprecation period, the project will be labeled End of Life.

6 changes: 6 additions & 0 deletions docs/project_lifecycle/end-of-life.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<!-- (SPDX-License-Identifier: CC-BY-4.0) --> <!-- Ensure there is a newline before, and after, this line -->

## End of Life

- A project that is no longer actively developed or maintained.

7 changes: 7 additions & 0 deletions docs/project_lifecycle/first-major-release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<!-- (SPDX-License-Identifier: CC-BY-4.0) --> <!-- Ensure there is a newline before, and after, this line -->

## First Major Release

- Hyperledger Explorer seeks graduation from the incubation phase

- A project’s maintainers seeking to publish a project’s first major release (see semver) must seek approval of the TSC whether in Active or Incubation status as defined above. While it is expected that most projects will have reached an Active status by the time their maintainers seek to announce a first major release, the TSC may approve such requests also in cases where the project is still in Incubation status, should the TSC believe that the project's code is sufficiently mature.
6 changes: 6 additions & 0 deletions docs/project_lifecycle/project-incubation-exit-criteria.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@

<!-- (SPDX-License-Identifier: CC-BY-4.0) --> <!-- Ensure there is a newline before, and after, this line -->

## Project Incubation Exit Criteria

- [Project Incubation Exit Criteria](https://wiki.hyperledger.org/display/HYP/Project+Incubation+Exit+Criteria)
8 changes: 8 additions & 0 deletions docs/project_lifecycle/proposal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<!-- (SPDX-License-Identifier: CC-BY-4.0) --> <!-- Ensure there is a newline before, and after, this line -->

## Proposal


- Hyperledger Explorer project was proposed by Christopher Ferris (IBM), Dan Middleton (Intel) and Pardha Vishnumolakala (DTCC)

- See more about proposal on [wiki](https://wiki.hyperledger.org/display/explorer/Hyperledger+Explorer), and [Google documents](https://docs.google.com/document/d/1Z8uR_w9E9XITEe88PzkLjzH9t5bPivUhQO8OiEP7s_U/edit)

0 comments on commit 4ed8706

Please sign in to comment.