search

czi-catalystproject / czi-catalystproject.github.io

Catalyst Project brochure website, built with JupyterBook.
https://catalystproject.cloud
MIT License
0 stars 1 forks source link
jupyterbook

readme

The Catalyst Project Website

This repo contains the Jupyter Book source files for the catalystproject.cloud brochure site.

About the Catalyst Project

Our goal is to create a collaborative cloud infrastructure service that enables community-based cloud-native workflows in the biosciences. We will promote values of open and inclusive community practices, infrastructure that enables these practices, and a “train the trainers” approach that empowers community leaders to share expertise in cloud infrastructure with others in their communities. Our focus will be on communities in Latin America and Africa, and we hope to learn how this model could be extended to other global communities that are historically marginalized from large-scale scientific infrastructure projects.[^1]

Contributing

See CONTRIBUTING.md if you would like to add a new page to the website or request a minor edit.

Getting Started

We recommend editing the contents of this repo using the 2i2c Community Showcase Hub.

[!NOTE] If you require collaborator access to this repo, please Get in Touch.

  1. Access the 2i2c Community Showcase Hub at https://showcase.2i2c.cloud/. If you require authorisation to access this hub, please Get in Touch.

  2. Select the Shared Small: 1-4 CPU, 8-32 GB server option and in the Image dropdown box select Handbook Authoring.

  3. Once the JupyterLab interface has loaded, set up GitHub authentication with gh-scoped-creds. This allows you to pull and push to GitHub repos. To enable this, open a terminal, run the command

    jovyan@jupyter-user:~$ gh-scoped-creds

    and follow the prompts to enter your code at https://github.com/login/device

  4. Git clone this project repo using the Terminal with the command

    jovyan@jupyter-user:~$ git clone https://github.com/czi-catalystproject/website.git

  5. Follow the how-to-guide for authoring and previewing content using Jupyter Book.

[!CAUTION] We do not recommend entering your GitHub credentials (GitHub password, personal access tokens or otherwise) on any kind of shared infrastructure (e.g. private and public cloud, HPC, any remote machine) as this information will be at risk. We highly advise using gh-scoped-creds for authentication on our hubs. Read this article for more information.

GitHub permissions for 2i2c-org and czi-catalystproject owners

These are extra instructions for GitHub 2i2c-org and czi-catalystproject owners to grant permissions to collaborators when requested.

Access to the Community Showcase Hub

Add the user to the 2i2c-org/Research-Delight-Team for access.

Add collaborator to this project repo

Go to the GH repo, click Settings -> Access - Collaborators and teams and add the relevant user or team. Assign the Write role in the first instance (this can be upgraded later if needed).

gh-scoped-creds and GitHub App

The GitHub App 2i2c Community Showcase Hub is currently installed on czi-catalystproject/website and czi-catalystproject/hub-champion-training repos to enable gh-scoped-creds.

Acknowledgements and Funding

We would like to acknowledge Chan Zuckerberg Initiative funding for the "A Collaborative Interactive Computing Service Model for Global Communities" project and our partner organisations:

Get in Touch

To report an issue with the website or ask a question about the project, please open an issue or send us an email.

[^1]: "New project: Open science cloud infrastructure and training for communities in Latin America and Africa" by Chris Holdgraf, available under CC-BY 4.0 at the 2i2c blog.