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.

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

[FAB-17196] Fix broken md structures in docs #377

Merged
merged 1 commit into from
Dec 10, 2019

Conversation

satota2
Copy link
Contributor

@satota2 satota2 commented Dec 6, 2019

This patch fixes broken markdown structures in documents on peerlifecycle commands.
Also, this patch includes a minor fix for removing references to alpha (ref. FAB-16157).
Signed-off-by: Tatsuya Sato Tatsuya.Sato@hal.hitachi.com

Type of change

  • Documentation update

Description

This patch fixes broken markdown structures in documents on peerlifecycle commands.
Also, this patch includes a minor fix for removing references to alpha (ref. FAB-16157).

Additional details

Related issues

https://jira.hyperledger.org/browse/FAB-17196
https://jira.hyperledger.org/browse/FAB-16157

binhn
binhn previously approved these changes Dec 8, 2019
Copy link
Contributor

@binhn binhn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The changes LGTM

Copy link
Member

@guoger guoger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, just some nits. would be nice if you could help fixing them :)

* Here is an example of the `peer lifecycle chaincode checkcommitreadiness` command,
which checks a chaincode named `mycc` at version `1.0` on channel `mychannel`.

```
export ORDERER_CA=/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/ordererOrganizations/example.com/orderers/orderer.example.com/msp/tlscacerts/tlsca.example.com-cert.pem
.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i believe this dot is not necessary

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for having reviews.
New patch removes unnecessary dots in the entire file.

@@ -109,16 +109,19 @@ channel `mychannel`.
### peer lifecycle chaincode checkcommitreadiness example

You can check whether a chaincode definition is ready to be committed using the
``peer lifecycle chaincode checkcommitreadiness command, which will return
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's not yours but we've been unnecessarily using double backticks in this file. would be nice to convert them to single backtick

Copy link
Contributor Author

@satota2 satota2 Dec 9, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for having reviews.
New patch converts unnecessary double backticks to single backtick in the entire file.

This patch fixes broken markdown structures in documents on peerlifecycle commands.

Also, this patch includes a minor fix for removing references to alpha
(ref. FAB-16157).

In addtion, this patch removes unnecessary dots and double backticks
in the entire file.

Signed-off-by: Tatsuya Sato <Tatsuya.Sato@hal.hitachi.com>
Copy link
Contributor

@nikhil550 nikhil550 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@jyellick jyellick merged commit 206795d into hyperledger:master Dec 10, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants