Hitchhiker's guide is intended to serve as a main resource for all Operate First community contributors. It contains documentation on how to perform contributor-related tasks and encourages input and contributions from the community. Jupyterbook format combines easy readability with quick way how to use newly acquired knowledge.
In the repository you can create virtual environment with pipenv
pipenv install --dev
after that you can enter created environment
pipenv shell
and build jupyter book
jupyter-book build .
Compiled book can be found in _build folder.
Derive new repositories from this template
List of featurese:
This template ensures new repos are created compliant with ADR 0001 and use GNU GPL v3 license.
AI-CoE CI provides easy and quick integration for build pipelines and checks for pull requests.
An empty .aicoe-ci.yaml is created here, disabling all checks via this CI provider by default. Documentation can be found here.
Prow is a CI provider developed for Kubernetes needs. Provides chat-ops management of pull requests, issues and declarative management for labels, branches and many more.
We host our own deployment of Prow in Operate First available at https://prow.operate-first.cloud/.
Supported commands are listed here. We have also enabled Prow to consume on-repository configuration files. You can specify your config in .prow.yaml. Additional centralized configuration can be found in the thoth-application repository.
By extension to Prow, we define a default pre-commit config for new repositories. Default hook configuration can be found in .pre-commit-config.yaml. Pre-commit is executed via Prow, see .prow.yaml for details.
We enable yamllint hook by default, since most of our repositories use yaml files extensively. Default configuration for this hook is located at yamllint-config.yaml.
To install and enable pre-commit locally please follow the instructions here.
It is advised for all contributors to enable pre-commit git hook via pre-commit install after cloning any repo within Operate First.