diff --git a/MAINTAINERS.rst b/MAINTAINERS.rst index a1757eaa4..f56f04adf 100644 --- a/MAINTAINERS.rst +++ b/MAINTAINERS.rst @@ -6,24 +6,27 @@ Maintainers ----------- -+---------------------------+---------------------+------------------+----------------+--------------------------------+ -| Name | Gerrit | GitHub | RocketChat | email | -+===========================+=====================+==================+================+================================+ -| Adam Kwan | adamk1230 | adamk1230 | adamk1230 | adamk1230@gmail.com | -+---------------------------+---------------------+------------------+----------------+--------------------------------+ -| Atsushi Neki | nekia | nekia | nekia | atsushin@fast.au.fujitsu.com | -+---------------------------+---------------------+------------------+----------------+--------------------------------+ -| David Huffman | dshuffma | | | dshuffma@us.ibm.com | -+---------------------------+---------------------+------------------+----------------+--------------------------------+ -| Jeeva Sankarapandian | jeevas | jeevasang | jeevas | jsankarapandian@dtcc.com | -+---------------------------+---------------------+------------------+----------------+--------------------------------+ -| Mekia Edwards | edwardsm26 | edwardsm26 | edwardsm26 | dev.edwardsm@gmail.com | -+---------------------------+---------------------+------------------+----------------+--------------------------------+ -| Nik Frunza | nfrunza | nickfrunza | nfrunza | nfrunza@gmail.com | -+---------------------------+---------------------+------------------+----------------+--------------------------------+ -| Satheesh Kathamuthu | satheeshk | xspeedcruiser | satheeshk | satheesh.ceg@gmail.com | -+---------------------------+---------------------+------------------+----------------+--------------------------------+ -| Umapathi Madiraju | umadiraj | umadiraju | umadiraj | umapathi.madiraju@gmail.com | -+---------------------------+---------------------+------------------+----------------+--------------------------------+ -| Vinita Chinoy | vchinoy | vchinoy-da | vchinoy | vinitachinoy@yahoo.com | -+---------------------------+---------------------+------------------+----------------+--------------------------------+ ++---------------------------+------------------+----------------+--------------------------------+ +| Name | GitHub | RocketChat | email | ++===========================+==================+================+================================+ +| Adam Kwan | adamk1230 | adamk1230 | adamk1230@gmail.com | ++---------------------------+------------------+----------------+--------------------------------+ +| Atsushi Neki | nekia | nekia | atsushin@fast.au.fujitsu.com | ++---------------------------+------------------+----------------+--------------------------------+ +| David Huffman | | | dshuffma@us.ibm.com | ++---------------------------+------------------+----------------+--------------------------------+ +| Jeeva Sankarapandian | jeevasang | jeevas | jsankarapandian@dtcc.com | ++---------------------------+------------------+----------------+--------------------------------+ +| Mekia Edwards | edwardsm26 | edwardsm26 | dev.edwardsm@gmail.com | ++---------------------------+------------------+----------------+--------------------------------+ +| Nik Frunza | nfrunza | nfrunza | nfrunza@gmail.com | ++---------------------------+------------------+----------------+--------------------------------+ +| Satheesh Kathamuthu | xspeedcruiser | satheeshk | satheesh.ceg@gmail.com | ++---------------------------+------------------+----------------+--------------------------------+ +| Umapathi Madiraju | umadiraju | umadiraj | umapathi.madiraju@gmail.com | ++---------------------------+------------------+----------------+--------------------------------+ +| Vinita Chinoy | vchinoy-da | vchinoy | vinitachinoy@yahoo.com | ++---------------------------+------------------+----------------+--------------------------------+ + +.. Licensed under Creative Commons Attribution 4.0 International License + https://creativecommons.org/licenses/by/4.0/ diff --git a/TROUBLESHOOT.md b/TROUBLESHOOT.md index 94d80984b..1798e9080 100644 --- a/TROUBLESHOOT.md +++ b/TROUBLESHOOT.md @@ -385,8 +385,8 @@ Related Information: ``` <<<<<<<<<<<<<<<<<<<<<<<<<< Explorer Error >>>>>>>>>>>>>>>>>>>>> { Error: 12 UNIMPLEMENTED: unknown service discovery.Discovery - at new createStatusError (/Users/USER_ID/workspace/gerrit/blockchain-explorer/node_modules/grpc/src/client.js:64:15) - at /Users/USER_ID/workspace/gerrit/blockchain-explorer/node_modules/grpc/src/client.js:583:15 + at new createStatusError (/Users/USER_ID/workspace/blockchain-explorer/node_modules/grpc/src/client.js:64:15) + at /Users/USER_ID/workspace/blockchain-explorer/node_modules/grpc/src/client.js:583:15 code: 12, metadata: Metadata { _internal_repr: {} }, details: 'unknown service discovery.Discovery' } diff --git a/devenv/submit_cr.rst b/devenv/submit_cr.rst deleted file mode 100644 index f6f5a9bd3..000000000 --- a/devenv/submit_cr.rst +++ /dev/null @@ -1,232 +0,0 @@ --- --- SPDX-License-Identifier: Apache-2.0 --- - -Submitting your first change request (CR) ------------------------------------------ - -We are using -`Gerrit `__ to -manage code contributions and reviews. If you are unfamiliar with Gerrit, -please review this :doc:`document ` before proceeding. - -.. note:: Gerrit has a reputation of having a clunky user experience. However, - the Google team has been working on improving this, and they have - added a "New UI" option that will allow you to work with their new - and much improved UX. See the link at the bottom of the Fabric - Gerrit page, linked above. - - .. image:: images/NewGerritUI.png - -Setting up your SSH key -~~~~~~~~~~~~~~~~~~~~~~~ - -Before you can submit a change set for review, you will need to register your -public SSH key. Login to -`Gerrit `__ with your -:doc:`LFID `, and click on your name in the upper -right-hand corner of your browser window and then click 'Settings'. - -.. image:: images/Settings.png - :width: 300px - -In the left-hand margin, you should see a link for 'SSH Public Keys'. - -.. image:: images/SSHKeys.png - :width: 200px - -Press the ``Add Key...`` button - -.. image:: images/AddSSH1.png - :width: 400px - -Copy-n-paste your `public SSH key `__ into -the window and press 'Add'. - -.. image:: images/AddSSH2.png - :width: 600px - - -Clone your project -~~~~~~~~~~~~~~~~~~ - -First step is to clone your project to your laptop or development server. -Navigate your browser to the Gerrit `Projects `__ -page and scroll down to the ``blockchain-explorer`` project. - -.. image:: images/lf-sandbox.png - :width: 500px - -The project page will provide you with the full git clone command needed to -clone the project. Select the ``clone with commit-msg hook`` option and copy the -command to the clipboard. - -.. image:: images/GitCloneCmd.png - :width: 600px - -Now, in a terminal window on your laptop, paste and run the command. e.g. - -.. code:: - - git clone "ssh://@gerrit.hyperledger.org:29418/blockchain-explorer" && scp -p -P 29418 @gerrit.hyperledger.org:hooks/commit-msg "blockchain-explorer/.git/hooks/" - -Checkout a development branch -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Now that you have cloned the repository, change directory to the ``lf-sandbox`` -directory. Now let's make a change. First, let's create a new branch in which -to work: - -.. code:: - - git checkout -b - -Now let's modify a file. Pick a file, any file and make a change. You can also -add a new file or delete an existing file. Don't be shy, this is just a -sandbox. - -Committing your change -~~~~~~~~~~~~~~~~~~~~~~ - -Once you've made your change, check to see what the current status is. - -.. code:: - - git status - On branch foo - Untracked files: - (use "git add ..." to include in what will be committed) - - README.md - - nothing added to commit but untracked files present (use "git add" to track) - -Now let's add the changed file to the list of files tracked by git. - -.. code:: - - git add . - -Now let's commit that change. - -.. code:: - - git commit -s - -This will open up an editing session using your favorite command-line editor -where you will fill in a commit message. Add a commit message. - -.. note:: Note that for the Hyperledger Fabric project(s) we would have a - title line that includes the JIRA number of the issue to which the - change request applies. Please review the - :doc:`guidelines ` for change requests. - -.. code:: - - FAB-1234 - - I made a change - - Signed-off-by: John Doe - - # Please enter the commit message for your changes. Lines starting - # with '#' will be ignored, and an empty message aborts the commit. - # On branch foo - # Changes to be committed: - # new file: README.md - # - -Submitting your change request -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Once you have saved the commit message, you can push the change request -to Gerrit. Here, we have a couple of options. - -The first option is to use the full git syntax. - -.. code:: - - git push origin HEAD:refs/for/master - -This will yield results something like the following: - -.. code:: - - Counting objects: 3, done. - Delta compression using up to 4 threads. - Compressing objects: 100% (2/2), done. - Writing objects: 100% (3/3), 340 bytes | 0 bytes/s, done. - Total 3 (delta 1), reused 0 (delta 0) - remote: Resolving deltas: 100% (1/1) - remote: Processing changes: new: 1, refs: 1, done - remote: Missing issue-id in commit message - remote: Commit 539d9a1fe036f332db87d37b49cea705bdf6e432 not associated to any issue - remote: - remote: Hint: insert one or more issue-id anywhere in the commit message. - remote: Issue-ids are strings matching ([A-Z][A-Z0-9]{1,9}-\d+) - remote: and are pointing to existing tickets on its-jira Issue-Tracker - remote: - remote: New Changes: - remote: https://gerrit.hyperledger.org/r/16157 I made a change - remote: - To ssh://gerrit.hyperledger.org:29418/lf-sandbox - * [new branch] HEAD -> refs/for/master - -The second option, -`git review `__ simplifies -things a bit. The link above will provide info on how to install and setup -``git-review``. - -Once installed and configured, you can submit your change with ``git review``. - -:: - - $ git review - - -Check that your change request is validated by the CI process -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -To ensure stability of the code and limit possible regressions, we use -a Continuous Integration (CI) process based on Jenkins which triggers -a build on several platforms and runs tests against every change -request being submitted. It is your responsibility to check that your -CR passes these tests. No CR will ever be merged if it fails the -tests and you shouldn't expect anybody to pay attention to your CRs -until they pass the CI tests. - -To check on the status of the CI process, simply look at your CR on -Gerrit, following the URL that was given to you as the result of the -push in the previous step. The History section at the bottom of the -page will display a set of actions taken by "Hyperledger Jobbuilder" -corresponding to the CI process being executed. - -Upon completion, "Hyperledger Jobbuilder" will add to the CR a *+1 -vote* if successful and a *-1 vote* otherwise. - -In case of failure, explore the logs linked from the CR History. If -you spot a problem with your CR and want to modify it, proceed to the -following section. - -If you see nothing wrong with your CR it might be that the CI process -simply failed for some reason unrelated to your change. In that case -you may want to restart the CI process by posting a reply to your CR -with the simple content "reverify". Check the `CI management page -`__ -for additional information and options on this. - -Modifying your change request -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -If you need to update your patch, say to address a review comment, or to fix -something affecting CI, you can commit revised changes with - -.. code:: - - git commit --amend - -and then repeat the ``git review`` or full syntax as before. Then -check the results of the CI process that gets triggered as a result. - -Should you have further questions, please don't hesitate to ask on the mailing -list or rocket chat. diff --git a/docs/project_lifecycle/Incubation.md b/docs/project_lifecycle/Incubation.md index 824a2e8fc..356071960 100644 --- a/docs/project_lifecycle/Incubation.md +++ b/docs/project_lifecycle/Incubation.md @@ -43,9 +43,7 @@ ## Infrastructure -- Gerrit or Github repo has been created - - - [Team code collaboration tool](https://gerrit.hyperledger.org/r/c/blockchain-explorer/+/31990) + - [Team code collaboration tool](https://github.com/hyperledger/blockchain-explorer) - [Hyperledger Explorer Repository](https://github.com/hyperledger/blockchain-explorer) - Mailing lists have been created and are archived diff --git a/docs/source/CONTRIBUTING.rst b/docs/source/CONTRIBUTING.rst index 16e0955d2..b3ce07886 100644 --- a/docs/source/CONTRIBUTING.rst +++ b/docs/source/CONTRIBUTING.rst @@ -111,7 +111,6 @@ Related Topics :maxdepth: 1 MAINTAINERS - jira_navigation dev-setup/devenv dev-setup/build Style-guides/js-style diff --git a/docs/source/MAINTAINERS.rst b/docs/source/MAINTAINERS.rst index d16373f9c..f56f04adf 100644 --- a/docs/source/MAINTAINERS.rst +++ b/docs/source/MAINTAINERS.rst @@ -6,27 +6,27 @@ Maintainers ----------- -+---------------------------+---------------------+------------------+----------------+--------------------------------+ -| Name | Gerrit | GitHub | RocketChat | email | -+===========================+=====================+==================+================+================================+ -| Adam Kwan | adamk1230 | adamk1230 | adamk1230 | adamk1230@gmail.com | -+---------------------------+---------------------+------------------+----------------+--------------------------------+ -| Atsushi Neki | nekia | nekia | nekia | atsushin@fast.au.fujitsu.com | -+---------------------------+---------------------+------------------+----------------+--------------------------------+ -| David Huffman | dshuffma | | | dshuffma@us.ibm.com | -+---------------------------+---------------------+------------------+----------------+--------------------------------+ -| Jeeva Sankarapandian | jeevas | jeevasang | jeevas | jsankarapandian@dtcc.com | -+---------------------------+---------------------+------------------+----------------+--------------------------------+ -| Mekia Edwards | edwardsm26 | edwardsm26 | edwardsm26 | dev.edwardsm@gmail.com | -+---------------------------+---------------------+------------------+----------------+--------------------------------+ -| Nik Frunza | nfrunza | nickfrunza | nfrunza | nfrunza@gmail.com | -+---------------------------+---------------------+------------------+----------------+--------------------------------+ -| Satheesh Kathamuthu | satheeshk | xspeedcruiser | satheeshk | satheesh.ceg@gmail.com | -+---------------------------+---------------------+------------------+----------------+--------------------------------+ -| Umapathi Madiraju | umadiraj | umadiraju | umadiraj | umapathi.madiraju@gmail.com | -+---------------------------+---------------------+------------------+----------------+--------------------------------+ -| Vinita Chinoy | vchinoy | vchinoy-da | vchinoy | vinitachinoy@yahoo.com | -+---------------------------+---------------------+------------------+----------------+--------------------------------+ ++---------------------------+------------------+----------------+--------------------------------+ +| Name | GitHub | RocketChat | email | ++===========================+==================+================+================================+ +| Adam Kwan | adamk1230 | adamk1230 | adamk1230@gmail.com | ++---------------------------+------------------+----------------+--------------------------------+ +| Atsushi Neki | nekia | nekia | atsushin@fast.au.fujitsu.com | ++---------------------------+------------------+----------------+--------------------------------+ +| David Huffman | | | dshuffma@us.ibm.com | ++---------------------------+------------------+----------------+--------------------------------+ +| Jeeva Sankarapandian | jeevasang | jeevas | jsankarapandian@dtcc.com | ++---------------------------+------------------+----------------+--------------------------------+ +| Mekia Edwards | edwardsm26 | edwardsm26 | dev.edwardsm@gmail.com | ++---------------------------+------------------+----------------+--------------------------------+ +| Nik Frunza | nfrunza | nfrunza | nfrunza@gmail.com | ++---------------------------+------------------+----------------+--------------------------------+ +| Satheesh Kathamuthu | xspeedcruiser | satheeshk | satheesh.ceg@gmail.com | ++---------------------------+------------------+----------------+--------------------------------+ +| Umapathi Madiraju | umadiraju | umadiraj | umapathi.madiraju@gmail.com | ++---------------------------+------------------+----------------+--------------------------------+ +| Vinita Chinoy | vchinoy-da | vchinoy | vinitachinoy@yahoo.com | ++---------------------------+------------------+----------------+--------------------------------+ .. Licensed under Creative Commons Attribution 4.0 International License https://creativecommons.org/licenses/by/4.0/ diff --git a/docs/source/dev-setup/devenv.rst b/docs/source/dev-setup/devenv.rst index 2a9cb96ff..13dd80a82 100644 --- a/docs/source/dev-setup/devenv.rst +++ b/docs/source/dev-setup/devenv.rst @@ -90,7 +90,7 @@ The process described here has several goals: Please follow these steps to have your contribution considered by the approvers: -* Ensure all commits have a Sign-off for DCO, as described in [DCO.md]. +* Ensure all commits have a Sign-off for DCO, as described in `DCO.md `__. * After you submit your pull request, verify that all `status checks `__ are passing. While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) diff --git a/docs/source/jira_navigation.rst b/docs/source/jira_navigation.rst deleted file mode 100644 index 178819a19..000000000 --- a/docs/source/jira_navigation.rst +++ /dev/null @@ -1,51 +0,0 @@ - -.. SPDX-License-Identifier: Apache-2.0 - - -Using Jira to understand current work items -=========================================== - -This document has been created to give further insight into the work in -progress towards the Hyperledger Explorer on the -community roadmap. - -It was determined to organize in sprints to better track and show a -prioritized order of items to be implemented based on feedback received. -We’ve done this via boards. To see these boards and the priorities click -on **Boards** -> **Manage Boards**: - -.. figure:: images/Jira.png - :width: 850px - :alt: Jira boards - - Jira boards - - -The meanings to these columns are as follows: - -- Backlog – list of items slated for the current sprint (sprints are - defined in 2 week iterations), but are not currently in progress -- In progress – items currently being worked by someone in the - community. -- In Review – items waiting to be reviewed and merged in Gerrit -- Done – items merged and complete in the sprint. - -If you want to see all items in the backlog for a given feature set, -click on the stacked rows on the left navigation of the screen: - -.. figure:: images/Jira4.png - :width: 850px - :alt: Jira boards - - Jira boards - -This shows you items slated for the current sprint at the top, and all -items in the backlog at the bottom. Items are listed in priority order. - -If there is an item you are interested in working on, want more -information or have questions, or if there is an item that you feel -needs to be in higher priority, please add comments directly to the Jira -item. All feedback and help is very much appreciated. - -.. Licensed under Creative Commons Attribution 4.0 International License - https://creativecommons.org/licenses/by/4.0/