TFOM Platform Guides

Usage

Building the book

If you'd like to develop on and build the TFOM Platform Guides book, you should:

• Clone this repository and run
• Run pip install -r requirements.txt (it is recommended you do this within a virtual environment)
• (Recommended) Remove the existing Guides/_build/ directory You can do this with jupyter-book clean Guides/ jupyter-book clean Guides/ -all will also remove the cache
• Run jupyter-book build Guides/

A fully-rendered HTML version of the book will be built in Guides/_build/html/.

Hosting the book

The html version of the book is hosted on the gh-pages branch of this repo. A GitHub actions workflow has been created that automatically builds and pushes the book to this branch on a push or pull request to main. The built and deployed version of the book in the gh-pages branch is rendered at https://futureofmeetings.github.io/Guides/introduction.html.

If you wish to disable this automation, you may remove the GitHub actions workflow and build the book manually by:

• Navigating to your local build; and running,
• ghp-import -n -p -f Guides/_build/html

This will automatically push your build to the gh-pages branch. More information on this hosting process can be found here.

NB this should be now automated using github action defined in .github/workflows/deploy.yml Any commit to the main branch should trigger this action.

Structure

The structure of this book is still to be determined.

The plan is that the book will host guides and reviews of various online meeting and collaboration platforms.

This section of the README should be updated once the book structure is determined.

Contributors

We welcome and recognize all contributions. You can see a list of current contributors in the contributors tab.

Credits

This project is created using the excellent open source Jupyter Book project and the executablebooks/cookiecutter-jupyter-book template.