uniteddiversity/handbook

Member's handbook describing the vision, processes, and culture of Hypha 🌿🍄

Handbook

Hypha handbook describing the vision, processes, and culture of Hypha Worker Co-operative. 🌿🍄

This handbook's primary audience is Hypha member-owners and collaborators, but it will be publicly available for others who might find it useful.

This resource is in perpetual beta and constantly changing. If you see something that could be improved, consider this your invitation to improve it!

📃 License

Copyright © 2018-2020 individual contributors.

Unless otherwise indicated it is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License. A copy is included with the handbook at LICENSE.

🛠 Technologies Used

• Gitbook. A command line tool to help build documentation.
• Node.js and npm. A programming language and package manager.
• GitHub Actions. A script-running service that deploys the handbook website for us in the cloud.

💻 Local Development

To submit changes, add content, and make improvements to this handbook you can use GitHub: github.com/hyphacoop/handbook.

To edit locally, you will have to install GitBook (currently deprecated), and Node.js (v4.0.0 or above) on your system.

It is easiest to install gitbook-cli with npm, the Node.js package manager. From your terminal, run the following command:

$ npm install gitbook-cli -g

You can preview any changes you make by running a local GitBook server:

$ gitbook serve

After starting the server, visit http://localhost:4000 (or the address indicated by the gitbook serve command) in a web browser.

🚀 Deployment

The handbook is automatically built and deployed using GitHub Actions after a Pull Request is merged into master on GitHub.

See: .github/workflows/deploy-github-pages.yml

Pull requests commits are lint-checked for concerns before merging.

See: .github/workflows/test-pull-request.yml