Skip to content
This repository has been archived by the owner on Jan 22, 2020. It is now read-only.

LFS171x Chapter 7 feedback discussion before I edit the markdown #103

Open
nathalie-ckc opened this issue Oct 4, 2018 · 2 comments
Open

Comments

@nathalie-ckc
Copy link

Hi @tkuhrt and anyone else working on the LFS171x improvements,

Here are my suggestions for improving Chapter 7 - Introduction to Hyperledger Fabric. If anyone feels strongly about any of them, please let me know in the next couple days. I plan to work on the markdown on the weekend (Oct 6-7).

  1. Key Components and Transaction Flow > Transaction Flow (Step 4)
    Typo: The ordering service, which is made up of a cluster of orderers, does not process transactions, smart contracts, or maintains the shared ledger. → maintain

  2. Key Components and Transaction Flow > What Does the MSP Do?
    a) The diagram doesn’t describe the flow in the text. The diagram matches the text on the previous slide (Membership Service Provider (MSP)) better, so I propose to move it there.
    b) Stretch goal, if I have time: Make a flow chart that matches the flow in the text on this slide

  3. Installing Hyperledger Fabric > Installing Hyperledger Fabric Docker Images and Binaries
    I got errors following these steps. Discussion forum post by tianzhong2015 at https://courses.edx.org/courses/course-v1:LinuxFoundationX+LFS171x+3T2017/discussion/forum/i4x-LinuxFoundationX-LFS171x-course-3T_2017/threads/5b6939f8c305ad0a19000db7 indicates that we should use version 1.2.0 to avoid the errors, and that worked for me.
    I propose to change the command to 'curl -sSL https://goo.gl/6wtTN5 | bash -s 1.2.0'

  4. Installing Hyperledger Fabric > Installing Hyperledger Fabric Docker Images and Binaries
    “the blue portion in the above curl command” There is no blue portion…
    I propose to make https://goo.gl/6wtTN5 blue and make the word 'blue' blue, as has been done lower down the page.

  5. Installing Hyperledger Fabric > Installing Hyperledger Fabric Docker Images and Binaries
    I propose to change “perform the following command for each of the Docker images:” to “perform the following command for each of the Fabric docker images" because, if you just did Chapter 6, you would have all the sawtooth images too & we don't mean for them to also tag those as latest.

  6. Installing Hyperledger Fabric > Installing Hyperledger Fabric Docker Images and Binaries
    “$ docker tag hyperledger/fabric-tools:x86_64-1.0.2 hyperledger/fabric-tools:latest” I think there needs to be 2 red portions (both 'fabric-tools'), but just 1 is red.
    I propose to make the second 'fabric-tools' red.

  7. Installing Hyperledger Fabric > Installing Hyperledger Fabric
    First, the previous slide caused fabric-samples to be cloned already. Second, you should cd into fabric-samples before you do the $PWD because you want fabric-samples/bin, but you don’t even need to do that because byfn.sh takes care of it for you on line 31.
    I propose to just delete this slide entirely.

  8. Writing an Application > Getting Started (Part II)
    ‘node registerAdmin.js’ fails with syntax error. Some students also filed Github issue node registerAdmin.js fails #64 about this.
    This post has the solution: https://courses.edx.org/courses/course-v1:LinuxFoundationX+LFS171x+3T2017/discussion/forum/i4x-LinuxFoundationX-LFS171x-course-3T_2017/threads/5b472605c5264809bd00139c
    I installed nvm using the instructions on the nvm github page README at https://github.com/creationix/nvm
    Then I did ‘nvm install v8.9.0’, as recommended by the discussion post
    Then I did ‘npm install’ again in the tuna-app directory, but got warnings about high risk vulnerabilities, so I ran the commands recommended in the warnings:

  • npm I npm@latest -g
  • npm install
  • npm audit fix
  • did ‘npm install’ again & just low risk vulnerabilities remaining. Was able to continue with the exercise from here.
    I propose to add to add another Troubleshooting section with the suggestion that you might need v8.9.0 and give the pointer to the nvm repo to install nvm, 'nvm install v8.9.0' and repeat 'npm install'
@nathalie-ckc
Copy link
Author

nathalie-ckc commented Oct 8, 2018

Regarding items 4 and 6 above: It looks like Github Markdown [doesn't support coloring text] (https://stackoverflow.com/questions/11509830/how-to-add-color-to-githubs-readme-md-file), so I will just specify the value of text that we want replaced.

nathalie-ckc added a commit to nathalie-ckc/education that referenced this issue Oct 8, 2018
"does not ... maintain"

Signed-off-by: nathalie-ckc <[email protected]>
nathalie-ckc added a commit to nathalie-ckc/education that referenced this issue Oct 8, 2018
Item 2a:
The diagram doesn’t describe the flow in the text. The diagram matches
the text on the previous slide (Membership Service Provider (MSP))
better, so I propose to move it there.

Item 2b was a stretch goal, which I didn't have time to implement.

Signed-off-by: nathalie-ckc <[email protected]>
nathalie-ckc added a commit to nathalie-ckc/education that referenced this issue Oct 8, 2018
I got errors following the steps for installing the fabric docker images
and binaries.

Discussion forum post by tianzhong2015 at
https://courses.edx.org/courses/course-v1:LinuxFoundationX+LFS171x+3T2017/discussion/forum/i4x-LinuxFoundationX-LFS171x-course-3T_2017/threads/5b6939f8c305ad0a19000db7
indicates that we should use version 1.2.0 to avoid the errors, and that
worked for me.

I propose to change the command to 'curl -sSL https://goo.gl/6wtTN5 |
bash -s 1.2.0'

Signed-off-by: nathalie-ckc <[email protected]>
nathalie-ckc added a commit to nathalie-ckc/education that referenced this issue Oct 8, 2018
In the actual edX course: “the blue portion in the above curl command” There is no blue portion...

Then in markdown, you can't specify color anyway (not even with HTML),
so I specified what is the text to replace.

Signed-off-by: nathalie-ckc <[email protected]>
nathalie-ckc added a commit to nathalie-ckc/education that referenced this issue Oct 8, 2018
I propose to change “perform the following command for each of the
Docker images:” to “perform the following command for each of the Fabric
docker images" because, if you just did Chapter 6, you would have all
the sawtooth images too & we don't mean for them to also tag those as
latest.

Likewise for the paragraph below that one.

Signed-off-by: nathalie-ckc <[email protected]>
nathalie-ckc added a commit to nathalie-ckc/education that referenced this issue Oct 8, 2018
“$ docker tag hyperledger/fabric-tools:x86_64-1.0.2
hyperledger/fabric-tools:latest” I think there needs to be 2 red
portions (both 'fabric-tools'), but just 1 is red in the edX course.

Then in markdown, you can't specify color anyway (not even with HTML),
so I specified what is the text to replace.

Signed-off-by: nathalie-ckc <[email protected]>
nathalie-ckc added a commit to nathalie-ckc/education that referenced this issue Oct 8, 2018
'Installing Hyperledger Fabric' is a redundant slide.

First, the slide 'Installing Hyperledger Fabric Docker Images and
Binaries' caused fabric-samples to be cloned already. I updated that
slide accordingly, because the 'bin' is no longer in the current
subdir, but rather in 'fabric-samples/bin'.

Second, you should cd into fabric-samples before you do the $PWD because
you want fabric-samples/bin, but you don’t even need to do that because
byfn.sh takes care of it for you on line 31.

So, I deleted the slide and updated the slide 'Getting Started with Your
First Network' to have you cd into 'fabric-samples/first-network'.

Signed-off-by: nathalie-ckc <[email protected]>
nathalie-ckc added a commit to nathalie-ckc/education that referenced this issue Oct 8, 2018
'node registerAdmin.jsr' fails with syntax error. Some students also
filed Github issue hyperledger-archives#64 about this.

This post has the solution:
https://courses.edx.org/courses/course-v1:LinuxFoundationX+LFS171x+3T2017/discussion/forum/i4x-LinuxFoundationX-LFS171x-course-3T_2017/threads/5b472605c5264809bd00139c

I installed nvm using the instructions on the nvm github page README
at https://github.com/creationix/nvm

Then I did 'nvm install v8.9.0', as recommended by the discussion
post

Then I did 'npm install' again in the tuna-app directory, but got
warnings about high risk vulnerabilities, so I ran the commands
recommended in the warnings:

    npm I npm@latest -g
    npm install
    npm audit fix

did ‘npm install’ again & just low risk vulnerabilities remaining.

Was able to continue with the exercise from here.

I propose to add to add another Troubleshooting section with the
suggestion that you might need v8.9.0 and give the pointer to the nvm
repo to install nvm, 'nvm install v8.9.0' and repeat 'npm install'

Signed-off-by: nathalie-ckc <[email protected]>
@nathalie-ckc
Copy link
Author

Submitted PR#105 to address this issue.

nathalie-ckc added a commit to nathalie-ckc/education that referenced this issue Oct 8, 2018
Deleting slide for item 7 didn't result in the TOC getting updated (Atom
package is supposed to update TOC on save), so I am deleting the TOC
entry for that slide manually.

Signed-off-by: nathalie-ckc <[email protected]>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Development

No branches or pull requests

1 participant