The book OpenCollaboration presents a vertical slice of strategies that have proven useful for a broad spectrum of organizations. This brief literary excursion provides the foundation for building an autonomous, flexible, and collaborative environment at the core of our company.

Roadmap

OpenCollaboration is under heavy development and undergoes continuous editing and restructuring. The main development currently focuses on rewriting the published chapters for coherent tone and interdependency. The additional roadmap for the v1 release currently looks as follows.

• Write Introduction
• Write Part I
• Write Part III
• Rewrite published chapters
• Improve website
  • Design landing page
  • Design social cards
  • Include analytics
• Write Part II
• Rewrite published chapters

Running locally

OpenCollaboration is written in Markdown and built to HTML via Material for MkDocs. In order to start working locally, follow the instructions to install Material for MkDocs.

Once installed, we create and render a book using mkdocs serve. This command automatically detects and hot reloads changes to the Markdown source.

Contributing

The contribution guidelines document strategies regarding prose and successfully integrating changes.

Versioning

OpenCollaboration follows the semantic versioning scheme.

• Patches include fixes to orthography, grammar, and punctuation.
• Minor version bumps cover larger edits and new chapters.
• Major version bumps contain changes to the content distribution or dramatic changes to the structure of the book.

Licensing

OpenCollaboration is licensed under the CC-BY-4.0 license, please review the LICENSE file for further details.

Built with ❤️ and

• Material for MkDocs
• Flowbite
• vale.sh

Helpful commands

# render and serve book
mkdocs serve

# lint using vale.sh
bash ci/vale.bash

# word count
find ./docs/book/ -type f -exec cat {} + | wc -w

# tailwind
npx tailwindcss -i ./input.css -o ./src/overrides/style.html