From b7ef15ade30e815580e0f17baf44b6a606921b9a Mon Sep 17 00:00:00 2001 From: Anik Date: Thu, 15 Jun 2023 16:20:01 -0400 Subject: [PATCH] Publish /docs to github pages Closes #291 Signed-off-by: Anik --- .github/workflows/pages.yaml | 24 ++++ .gitignore | 2 + docs/Tasks/adding-a-catalog.md | 85 ++++++++++++++ docs/Tasks/deleting-an-operator.md | 21 ++++ docs/Tasks/explore-available-packages.md | 142 +++++++++++++++++++++++ docs/Tasks/installing-an-operator.md | 69 +++++++++++ docs/components.md | 12 ++ docs/index.md | 35 ++++++ docs/olmv1_roadmap.md | 27 +---- mkdocs.yml | 8 ++ 10 files changed, 404 insertions(+), 21 deletions(-) create mode 100644 .github/workflows/pages.yaml create mode 100644 docs/Tasks/adding-a-catalog.md create mode 100644 docs/Tasks/deleting-an-operator.md create mode 100644 docs/Tasks/explore-available-packages.md create mode 100644 docs/Tasks/installing-an-operator.md create mode 100644 docs/components.md create mode 100644 docs/index.md create mode 100644 mkdocs.yml diff --git a/.github/workflows/pages.yaml b/.github/workflows/pages.yaml new file mode 100644 index 000000000..8436fe4da --- /dev/null +++ b/.github/workflows/pages.yaml @@ -0,0 +1,24 @@ +name: Deploy Documentation site +on: + push: + branches: + - main +permissions: + contents: write +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-python@v4 + with: + python-version: 3.x + - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV + - uses: actions/cache@v3 + with: + key: mkdocs-material-${{ env.cache_id }} + path: .cache + restore-keys: | + mkdocs-material- + - run: pip install mkdocs-material + - run: mkdocs gh-deploy --force \ No newline at end of file diff --git a/.gitignore b/.gitignore index ecfd7f0f4..d6b142bfe 100644 --- a/.gitignore +++ b/.gitignore @@ -34,3 +34,5 @@ install.sh \#*\# .\#* +# documentation website asset folder +docs/_site \ No newline at end of file diff --git a/docs/Tasks/adding-a-catalog.md b/docs/Tasks/adding-a-catalog.md new file mode 100644 index 000000000..56235c404 --- /dev/null +++ b/docs/Tasks/adding-a-catalog.md @@ -0,0 +1,85 @@ +--- +layout: default +title: Adding a catalog of operators to the cluster +nav_order: 1 +parent: Tasks +--- + +Operator authors have the mechanisms to offer their product as part of a curated catalog of operators, that they can push updates to over-the-air (eg publish new versions, publish patched versions with CVEs, etc). Cluster admins can sign up to receive these updates on clusters, by adding the catalog to the cluster. When a catalog is added to a cluster, the kubernetes extension packages (operators, or any other extension package) in that catalog become available on cluster for installation and receiving updates. + +For example, the [k8s-operatorhub/community-operators](https://github.com/k8s-operatorhub/community-operators) is a catalog of curated operators that contains a list of operators being developed by the community. The list of operators can be viewed in [Operatorhub.io](https://operatorhub.io). This catalog is distributed as an image [quay.io/operatorhubio/catalog](https://quay.io/repository/operatorhubio/catalog?tag=latest&tab=tags) for consumption on clusters. + +To consume this catalog on cluster, create a `Catalog` Custom Resource(CR) with the image specified in the `spec.source.image` field: + +```bash +$ kubectl apply -f - <