https://github.com/googlecloudplatform/kubeflow-gke-docs

Documentation for Kubeflow on Google Cloud
https://github.com/googlecloudplatform/kubeflow-gke-docs

documentation gcp gke google-cloud google-cloud-platform kubeflow kubeflow-cluster kubeflow-pipelines kubernetes machine-learning mlops pipelines

Last synced: 4 months ago
JSON representation

Documentation for Kubeflow on Google Cloud

• Host: GitHub
• URL: https://github.com/googlecloudplatform/kubeflow-gke-docs
• Owner: GoogleCloudPlatform
• License: cc-by-4.0
• Created: 2022-12-12T21:30:18.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-11-21T19:38:04.000Z (about 1 year ago)
• Last Synced: 2023-11-21T23:46:01.039Z (about 1 year ago)
• Topics: documentation, gcp, gke, google-cloud, google-cloud-platform, kubeflow, kubeflow-cluster, kubeflow-pipelines, kubernetes, machine-learning, mlops, pipelines
• Language: Python
• Homepage: https://googlecloudplatform.github.io/kubeflow-gke-docs/
• Size: 60.1 MB
• Stars: 7
• Watchers: 4
• Forks: 9
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Build dev](https://github.com/GoogleCloudPlatform/kubeflow-gke-docs/actions/workflows/hugo-build-deploy-on-push.yml/badge.svg?branch=main)

# Contributing to this repository

Welcome, Kubeflow users! This website contains the latest documentation for Kubeflow on Google Cloud. It is hosted at https://googlecloudplatform.github.io/kubeflow-gke-docs. 

Before contributing, please read [these guidelines](./CONTRIBUTING.md).

## Running locally

1. This website is being generated with [Hugo](https://gohugo.io/), a popular open-source static site generator. You will need to install the `extended` version of Hugo to be able to generate a website locally.

    You can install Hugo using `brew`:

    ```bash

    brew install hugo

    ```

    Alternatively, you can also use `snap`:

    ```bash

    snap install hugo --channel=extended

    ```

    Check the [official documentation](https://gohugo.io/getting-started/installing/) on other installation options. See more details on how to deploy [GitHub pages static website using Hugo](https://gohugo.io/hosting-and-deployment/hosting-on-github/).

1. We use [Docsy](https://github.com/google/docsy) theme, which has its prerequisites.

    ```bash

    npm install --save-dev autoprefixer

    npm install --save-dev postcss-cli

    npm install -D postcss

    ```

    If you don't have `npm`, install it using:

    ```bash

    sudo apt-get install npm

    ```

1. To run the website locally:

    ```bash

    hugo server

    ```

## Contributing

See [CONTRIBUTING.md](https://github.com/googlecloudplatform/kubeflow-gke-docs/blob/main/CONTRIBUTING.md).

## Releasing a new version

See [RELEASE.md](https://github.com/googlecloudplatform/kubeflow-gke-docs/blob/main/RELEASE.md).