Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BE-708 Online docs issues #56

Merged
merged 2 commits into from
Nov 21, 2019
Merged

BE-708 Online docs issues #56

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9cc9d07
BE-708 Online docs issues
nfrunza Nov 20, 2019
b7aa7e9
[BE-708] Online docs issues
nfrunza Nov 21, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,9 @@ _In general a commit serves a single purpose and diffs should be easily comprehe
For this reason do not mix any formatting fixes or code moves with actual code changes._
1. **Commit your changes** see [How to Write a Git Commit Message](https://chris.beams.io/posts/git-commit/) article by Chris Beams.
1. **Test your changes** locally before pushing to ensure that what you are proposing is not breaking
another part of the software. Running the `./main.sh clean && ./main.sh install && ./main.sh test` command locally will help you
to be confident that your changes will pass CI tests once pushed as a Pull Request.
another part of the software.
Running the ```./main.sh clean && ./main.sh install && ./main.sh test``` command locally will help you to be confident that your changes will
pass CI tests once pushed as a Pull Request.
1. **Push your changes** to your remote fork.
1. **Create a pull-request** (PR) on the Hyperledger Explorer repository. If the PR addresses an existing Jira issue,
include the issue number in the PR title in square brackets (for example, `[BE-333]`).
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[rocketchat-image]:https://open.rocket.chat/images/join-chat.svg
[![Build Status](https://dev.azure.com/Hyperledger/blockchain-explorer/_apis/build/status/hyperledger.blockchain-explorer?branchName=master)](https://dev.azure.com/Hyperledger/blockchain-explorer/_build/latest?definitionId=41&branchName=master)
[![CII Best Practice](https://bestpractices.coreinfrastructure.org/projects/2710/badge)](https://bestpractices.coreinfrastructure.org/projects/2710)
[![Documentation Status](https://readthedocs.org/projects/blockchain-explorer/badge/?version=latest)](https://blockchain-explorer.readthedocs.io/en/latest/?badge=mster)
[![Documentation Status](https://readthedocs.org/projects/blockchain-explorer/badge/?version=master)](https://blockchain-explorer.readthedocs.io/en/master/?badge=master)

<!-- badges -->

Expand Down
27 changes: 10 additions & 17 deletions docs/source/CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ project, you will need a `Linux Foundation account <https://identity.linuxfounda

You will need to use your LF ID to access to all the Hyperledger community tools, including:

* `Jira <https://jira.hyperledger.org>`__.
* `RocketChat <https://chat.hyperledger.org>`__.
* `Jira <https://jira.hyperledger.org/projects/BE/issues>`__.
* `RocketChat <https://chat.hyperledger.org/channel/hyperledger-explorer>`__.
* `Mailing list <https://lists.hyperledger.org/g/explorer>`__.


Expand Down Expand Up @@ -62,6 +62,13 @@ Verified Docker versions supported:
- `Docker Compose 1.14.0 <https://docs.docker.com/compose>`__


Working on fixing issues and working stories
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Review the `issues list <https://jira.hyperledger.org/projects/BE/issues>`__ and find something that interests you.
Start with something relatively straight forward and achievable, and that no one is already assigned. If no one is assigned, then assign the issue
to yourself. Please be considerate and rescind the assignment if you cannot finish in a reasonable time, or add a comment saying that you are
still actively working the issue if you need a little more time.

Submitting your fix
~~~~~~~~~~~~~~~~~~~
Expand All @@ -71,28 +78,14 @@ provide a fix, we would welcome that gladly! Please assign the JIRA issue to
yourself, then you can submit a change request (PR), please follow guidance provided by `CONTRIBUTING.md <https://github.com/hyperledger/blockchain-explorer/blob/master/CONTRIBUTING.md>`__.


Working on fixing issues and working stories
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Review the `issues
list <https://jira.hyperledger.org/secure/RapidBoard.jspa?rapidView=155&view=planning.nodetail>`__ and find
something that interests you.
Start with something relatively straight forward and
achievable, and that no one is already assigned. If no one is assigned,
then assign the issue to yourself. Please be considerate and rescind the
assignment if you cannot finish in a reasonable time, or add a comment
saying that you are still actively working the issue if you need a
little more time.


Copyright Notices
~~~~~~~~~~~~~~~~~~~

There should be a single LICENSE file in the top-level directory that contains the full text of the Apache License `here <http://www.apache.org/licenses/LICENSE-2.0>`__.





.. note:: In the individual files, please use the following line:


Expand Down
16 changes: 2 additions & 14 deletions docs/source/architecture/sync_configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Configuration
:title: Run host (Standalone)

* From new terminal (if Sync Process in Standalone).

* ``cd blockchain-explorer/``
* ``./syncstart.sh`` (it will have the sync node up).
* ``./syncstop.sh`` (it will stop the sync node).
Expand All @@ -70,7 +70,7 @@ Configuration

.. attention::

* Please restart Explorer if any changes made to explorerconfig.json.
* Please restart Explorer if any changes made to `explorerconfig.json <https://github.com/hyperledger/blockchain-explorer/blob/master/app/explorerconfig.json>`__.

* If the Hyperledger Explorer was used previously in your browser be sure to clear the cache before relaunching.
* If Hyperledger Fabric network is deployed on other machine, please toggle ``DISCOVERY_AS_LOCALHOST`` in ``start.sh / syncstart.sh to 'false'``.
Expand All @@ -79,15 +79,3 @@ Configuration














.. TODO
1 change: 0 additions & 1 deletion docs/source/architecture/websockets.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,3 @@ new block details is provided in the notification panel.
.. raw:: html
:file: ./websockets.html

.. TODO
2 changes: 1 addition & 1 deletion docs/source/dev-setup/devenv.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ This facilitates social contribution, easy testing, and peer review.

To contribute changes, use the following workflow:

* `Fork the repository <https://github.com/hyperledger/blockchain-explorer/form>`__.
* `Fork the repository <https://github.com/hyperledger/blockchain-explorer/fork>`__.
* Clone your fork to your computer.
* Create a topic branch and name it appropriately. Starting the branch name with the issue number is a good practice and a reminder to fix only one issue in a Pull-Request (PR).
* Make your changes, adhering to the documentation conventions described below. In general a commit serves a single purpose and diffs should be easily comprehensible. For this reason do not mix any formatting fixes or typo fixes with actual documentation changes.
Expand Down