InnerSource Theory Training Manual
Welcome to the InnerSource Theory Training Manual repo. In this repo, you will find the content used by GitHub during our official training courses and scripts used when teaching.
If you have access to this repository, it is because your company has an agreement with GitHub to use these materials. Your use of these materials is described by that agreement.
Deploy the manual
These manuals are designed to be generated using docsify. To get your own manuals up and running, all you have to do is:
- Fork this repository
- In your fork, click on Settings
- Scroll down to the GitHub Pages section, and set Source: to
master branch /docs folder. - Click Save.
- Return to the GitHub Pages section of Settings, and you'll receive the URL of your published manual.
Make changes
The official docsify documentation is your best bet for getting up to speed with the tool.
In general, you'll find all of the manual content in the docs/ folder of this repository. All content is written in Markdown, and it's all stitched together in docs/_sidebar.md, which specifies the order and hierarchy of the content.
Preview changes on your machine
You can install, and serve the contents of the docs/ folder locally with minimal setup. The steps are thoroughly described in the doscify quick start guide.
You can also simply run the following scripts:
script/bootstrap
script/serverTeaching scripts
Scripts that accompany the manual, and their documentation can be found in the script/ directory.