Page tree
Skip to end of metadata
Go to start of metadata

 https://github.com/hyperledger/learning-materials-dev

Purpose:


Hosting content that makes sense to have in GitHub (i.e. where source control makes sense, as opposed to using the wiki) that the LMDWG members want to share for collaboration.  Ideally, this should just be a "development" area where it is being prepped for some greater purpose in the published Hyperledger documentation space.  This should not be the final destination where a contribution comes to grow old and die, since we're a development working group.

Structure:

  • LICENSE governing the contents of the repo.  Ry Jones, Hyperledger Community Architect, has set us up with Apache 2.0 in the currently empty repo.
  • ACTIVE/<project> holds active projects
  • ARCHIVE/<old-project> holds projects that are no longer being maintained.  
  • README.md explains the purpose of the repo
  • CONTRIBUTING.md explains how to contribute a <project> and how to file issues. It would point to ACTIVE/<project>/CONTRIBUTING.md files for specifics on how to contribute to each <project>
  • ACTIVE/<project>/README.md explains what <project> is, how to use it, and its intended destination
  • ACTIVE/<project>/CONTRIBUTING.md gives requirements for how to contribute to each <project>  
  • ACTIVE/<project>/MAINTAINERS.md lists who is responsible for <project>
  • ACTIVE/<project>/TESTING.md explains how to run the tests for the project

Rules:


  • Anyone who contributes a <project> must be willing to be the maintainer of that <project>.  This means answering questions, responding to issues, keeping things up-to-date, and driving the contribution to its destination in the published Hyperledger documentation space.  They may have co-maintainers.
  • Issues should be reported using the GitHub issues mechanism.  We should come up with some guidelines to make sure people submit issues with relevant details.  We should also come up with expected response time for the maintainers to respond to issues.
  • Contributions should be submitted by GitHub Pull Request.  For anything that involves code, it must have a test suite to ensure nothing breaks and passing tests and instructions for others to run the test suite.  New contributions must also pass the test suite and, if implementing new features not covered by the test suite, new tests should also be submitted to the test suite & everything should pass.  
  • Any ACTIVE/<project> that has had no updates for a year will be moved to ARCHIVE/ and all the Issues & PRs for it will be closed as obsolete.  This can happen sooner at the request of the <project> maintainer.
  • Any other suggestions for rules?  



Hi all,

Just checking to see if anyone has any suggestions/feedback on the proposal.  Or, if you will be joining the LMDWG call on Monday, perhaps we can discuss then.

Best regards,
Nathalie



On Fri, Jan 31, 2020 at 10:18 AM Silona Bonewald <sbonewald@linuxfoundation.org> wrote:

You are doing some great work here Nathalie! 

Thank you



On Thu, Jan 30, 2020 at 5:48 PM Nathalie C. Chan King Choy <nathalie-ckc@kestrel-omnitech.com> wrote:
Hi all,

For those who didn't catch it in the recent LMDWG calls, we have a new GitHub repo for the LMDWG at hyperledger/learning-materials-dev.  

(Some of you may recall the hyperledger/education repo that we were involved with.  The purpose of that repo was the EdX courses and it became obsolete.  The old education repos were archived and can now be found read-only at hyperledger-archives/education and hyperledger-archives/education-cryptomoji)

Before we start populating it, I propose we have a plan for its structure and some rules.  Here are my thoughts and I request your comments & feedback, especially if any of you have experience as GitHub repo maintainers.

Purpose:
Hosting content that makes sense to have in GitHub (i.e. where source control makes sense, as opposed to using the wiki) that the LMDWG members want to share for collaboration.  Ideally, this should just be a "development" area where it is being prepped for some greater purpose in the published Hyperledger documentation space.  This should not be the final destination where a contribution comes to grow old and die, since we're a development working group.

Structure:

  • LICENSE governing the contents of the repo.  Ry Jones, Hyperledger Community Architect, has set us up with Apache 2.0 in the currently empty repo.
  • ACTIVE/<project> holds active projects
  • ARCHIVE/<old-project> holds projects that are no longer being maintained.  
  • README.md explains the purpose of the repo
  • CONTRIBUTING.md explains how to contribute a <project> and how to file issues. It would point to ACTIVE/<project>/CONTRIBUTING.md files for specifics on how to contribute to each <project>
  • ACTIVE/<project>/README.md explains what <project> is, how to use it, and its intended destination
  • ACTIVE/<project>/CONTRIBUTING.md gives requirements for how to contribute to each <project>  
  • ACTIVE/<project>/MAINTAINERS.md lists who is responsible for <project>
  • ACTIVE/<project>/TESTING.md explains how to run the tests for the project

Rules:


  • Anyone who contributes a <project> must be willing to be the maintainer of that <project>.  This means answering questions, responding to issues, keeping things up-to-date, and driving the contribution to its destination in the published Hyperledger documentation space.  They may have co-maintainers.
  • Issues should be reported using the GitHub issues mechanism.  We should come up with some guidelines to make sure people submit issues with relevant details.  We should also come up with expected response time for the maintainers to respond to issues.
  • Contributions should be submitted by GitHub Pull Request.  For anything that involves code, it must have a test suite to ensure nothing breaks and passing tests and instructions for others to run the test suite.  New contributions must also pass the test suite and, if implementing new features not covered by the test suite, new tests should also be submitted to the test suite & everything should pass.  
  • Any ACTIVE/<project> that has had no updates for a year will be moved to ARCHIVE/ and all the Issues & PRs for it will be closed as obsolete.  This can happen sooner at the request of the <project> maintainer.
  • Any other suggestions for rules?  

I still need to find out from Ry how commit rights work with the Hyperledger repositories.

Thanks & regards,

Nathalie C. Chan King Choy
Project Manager focused on Open Source and Community

12/17 email

Nathalie.


We should include The Linux Foundation education/training group in these discussions. This repository was initially created to house all of the educational material that was created for the different Hyperledger courses. This did not happen. I am not aware of the status of the EdX course in comparison to what is currently in the education repository. I know that a lot of the demo-specific content was supposed to be removed from the EdX course, as it was hard to keep the material up to date with the rapidly changing frameworks. As such, I am curious if it makes sense to archive the education repository.


Community Architects.


It would be worthwhile to have this conversation with Flavia at The Linux Foundation to see if this repository is still being used for the EdX course. If not, I vote to archive this repository.


Tracy



12/14 Email

Hi Ry, Kelly & Ravi,
 
At the last Hyperledger Learning Materials Development WG meeting, I signed up to populate the README of the hyperledger/education repo to help people who stumble across it know how they can contribute.
 
Bobbi indicated during the call that the group doesn't really use it because LMDWG isn't hosting code & mainly contribution happens on the wiki.  
 
For LFS171x, I see from reading Kelly's & Ravi's wiki comments that what's in GitHub is out of date & more recent feedback on revisions of the course was being provided via wiki pages (not GitHub).  Bobbi indicated in the last call that much of the group is not up for using Git, many not being devs.  Also, PRs dating back to 2018 and 2017 weren't merged, even after feedback was addressed.  And, issues aren't being addressed either.   The impression I get from visiting the repo is it's bit-rotted and a dead repo...
 
However, the commits show that Ry was merging even in Aug 2019...
 
So, questions: 
1) Is LFS171x being generated from the education GitHub repo sources?
 
2) Does LMDWG want contributors to file issues & PRs on hyperledger/education/LFS171x? 
 
3) Are there currently plans for any other LMDWG work to go into the education repo, or should my README text point all contributors to the wiki to find out how they can contribute?
 
4) If I make a PR to update the README, would it get merged? 
 
Thanks & regards,
Nathalie C. Chan King Choy
Project Manager focused on Open Source & Community
RESPONSE
Hi Ry, Tracy, Sasha & Nicola,

@Ry: Thanks for the pointer to the right folks.
I'm not able to view that link even when signed in to GitHub & Hyperledger LF ID.  I took about a year off from volunteering with the working group, so I think I lost my membership to the Hyperledger GitHub organization, which is probably what I need in order to have permissions to view https://github.com/orgs/hyperledger/teams/education-maintainers/members.  I didn't have 2-factor set up on my GitHub at the time & missed the window for setting it up in time. 

Is it possible to add me back to the GitHub org?

Thanks for confirming someone will merge the PR :)

@Tracy, Sasha, and Nicola:

The scope of my task is to:

  • Learn what the current contribution governance is around the hyperledger/education repo
  • Learn the current purpose of hyperledger/education/LFS171x
  • And to document these in the README (or wherever appropriate) so that people who stumble across the GitHub repo & want to contribute to the LMDWG spend their available cycles effectively to move the projects forward.

Here are some questions regarding that:
  1. Are there currently plans for any other LMDWG work to go into the education repo, or should my README text point all contributors to the wiki to find out how they can contribute? 
  2.  What is the criteria for new sub-repos to come under hyperledger/education?  
    • e.g. Must the sub-repo have someone who volunteers to be the maintainer?  If so, what are the responsibilities of that sub-repo maintainer? 
    • e.g. Must tests/CI be submitted along with that new sub-repo?  
    • e.g. Must a license be defined?
    • e.g. Must a CONTRIBUTING.md be submitted?
    • e.g. Who must keep that sub-repo up-to-date?
    • etc.
  3.  Is education/LFS171x still being used?  If so, how is it being used & how should people contribute?  If not, where should issues & contributions be sent and what's the process for archiving the repo so that potential contributors don't waste effort filing issues & PRs in the wrong place?
    • The impression I get from visiting the repo is no longer in use... PRs dating back to 2018 and 2017 weren't merged, even after feedback was addressed.  And, Issues aren't being addressed either.   
    • It looks like more recent feedback on revisions of the course was being provided via wiki pages (not GitHub)
    • Still, I want to confirm what I observe is correct, since I had taken a long break from volunteering

Thanks & regards,

Nathalie C. Chan King Choy
Project Manager focused on Open Source & Community



On Sat, Dec 14, 2019 at 6:16 PM Ry Jones <rjones@linuxfoundation.org> wrote:

Hi Nathalie,
That repo is maintained by Tracy, Nicola, and Sasha:
https://github.com/orgs/hyperledger/teams/education-maintainers/members
(you may need to be logged in to see that)

I will gladly delegate control to anyone that wants to step up and take it. I would ask to co-ordinate with those three, though.

Everything I merged was a security update from DependaBot. If you need, I will gladly merge an update to the readme. I also ask you to consider archiving the education-cryptomoji repo.
Ry

https://github.com/hyperledger/education

https://github.com/hyperledger/education/tree/import-edx-content/LFS171x/docs


Git Hub Info

https://github.com/ravinayag/fabric-samples-explained/


Github 


RequestDateIssue
Issues Installing Fabric Docker Images3/8/2019https://courses.edx.org/courses/course-v1:LinuxFoundationX+LFS171x+3T2017/discussion/forum/i4x-LinuxFoundationX-LFS171x-course-3T_2017/threads/5c6818483eb9e6099d0027ff
Burrow Documentation9/19A few months of documentation miscellaneous contributions. 


How to contribute:

https://gist.github.com/tkuhrt/10211ae0a26a91a8c030d00344f7d11b

https://docs.google.com/document/d/1OgxQp317xpza2LOAY9uHPzPxs_B6ZgeycsCaBJ5c0sk/edit

https://github.com/hyperledger/education/tree/import-edx-content/LFS171x/docs

  • No labels

3 Comments

  1. This weekend I forked Education and will go through files, per Flavia's comment that most of GitHub is not current. Is Ravi working on organizing GitHub or should I? 

  2. Kelly Cooper I'm good to start with documentation updates, However waiting for a response from Bobbi's.   we can work together to organize the github. I'm available @ ravinayag@gmail.com

  3. Hello,

    I just returned from a trip out of the country, sorry for the slow response.

    I am glad the communication between you has started.  Any chance you could give a 5-10 presentation about the Git Hub sections so we can determine where we are and where we need to be. Thanks Bobbi