This repository contains the reference material related to the OpenChain Project. There are around 1,000 documents in this reference library at the moment. These documents are in various formats.
The OpenChain Education Work Group is working on making it easier to access, convert and share key reference material.
We plan to do this through providing the source material in MarkDown. People can change it into PDF documents, Word documents and other formats from there.
The reason for this change is to allow people to easily contribute to our editing via our Reference Library. This is hosted on GitHub and it favors formats like MarkDown that are basically text.
Our first step is to convert some existing documents into MarkDown. This will allow us to begin editing and updating them.
There is an online tool to convert Word documents to MarkDown, which is the first step of the process. You will find it here: https://word2md.com
Our Reference Library is here: https://github.com/OpenChain-Project/Reference-Material
It contains a lot of documents. If you are looking for suggestions on documents to convert first, please see: https://github.com/OpenChain-Project/Reference-Material/blob/master/markdown-conversion-queue.md
If you convert one of these documents to MarkDown, please open a Pull Request to submit the updated document. If you need help with that, please ask our education work group at this mailing list: https://lists.openchainproject.org/g/education/messages
Now you can help with updating the documentation! The process is the same. Update the MarkDown and submit a pull request.
There is a small learning curve to take part in this new drive. However, it is quick, easy and free to get a graphical editor for MarkDown. Download it here: https://panwriter.com. Of course, this is only one of the tools that you can use, as MarkDown is supported by many editors.
Then download background tools for MarkDown: https://pandoc.org/installing.html
You might want to try using git directly at home, so that you can clone the repo, commit changes to it, branch the repo to include your modification in a separate branch, push the branch with your changes and any subsequent commits you add. While it is largely unnecessary, by getting familiar with the tool you could later exploit all the power of it.
That’s it! You are ready to help. We look forward to working together to make sure even more people can take advantage of our reference library as they work towards a more trusted, more efficient and more effective supply chain.