Skip to content

README.md

Latest commit

 

History

History
58 lines (34 loc) · 2.02 KB

README.md

File metadata and controls

58 lines (34 loc) · 2.02 KB

GKE AI Labs Website

This repository contains the source code for the GKE AI Labs website.

Contributing

The AI on GKE website website can be run locally and on AppEngine. Please read the contributing guide for directions on submitting pull requests.

Structure changes

If you are moving the guide between folders, please make sure you have added redirect entry to this file.

Heading

The highest heading in the guide should be ##, which corresponds to h2 level. H1 always reserved by tittle from the frontmatter.

Embed .md file from external public github repository

In case you want to add .md file from external github repository:

  1. Provide additional following parameters to the frontmatter:
    externalSource:
        repository: "organisation/repository"
        branch: "branchName"
        filePath: "filePath"
  1. Add {{% include-external %}} as a content.
  2. If your external .md file contains any images, create images folder under the same level your .md presented and put all images there.

You can refer to this example.

Content of this file will be automatically updated on each rebuild. In case some urls are not valild build process will fail. Last modified date will set to the date of last commit in origin repository.

License

Build & Deploy

Run website locally

docker run --rm -it -v $(pwd):/src -p 1313:1313 floryn90/hugo:ext-alpine server

Build static files locally:

  • Use build -e production in order to get minified source files

docker run --mount type=bind,src=./,dst=/src floryn90/hugo:ext-alpine build

Deployment to AppEngine

Deployment happens automatically on push to main branch using following github actions workflow file