Skip to content

Latest commit

 

History

History
81 lines (50 loc) · 3.43 KB

README.md

File metadata and controls

81 lines (50 loc) · 3.43 KB
Raw

The Harbor website

This repo houses the assets used to build the Harbor website, available at https://goharbor.io.

Tools

The website is built and developed using the Hugo static site generator.

Instructions for installing Hugo can be found here. Use the version of Hugo specified by the HUGO_VERSION environment variable in the netlify.toml configuration file, and make sure to install the "extended" version of Hugo with support for Hugo Pipes.

Website content

The content for the Harbor blog is in content/blog, while the content for the Harbor documentation is in the docs folder.

Specific instructions for documentation

The latest (edge) version of the documentation lives in the docs folder, and is always viewable on https://goharbor.io/docs/edge. When updating this version and making a PR, the edge docs will be viewable through the Netlify preview linked in the PR tests, just make sure you add /docs/edge/ to the URL. That way you can verify that your changes look good before asking the maintainers for a review.

When updating already released versions of the documentation, please make changes and PRs against the release-X branches.

When creating docs for a new release, please create a branch with the format release-X.Y.Z. When you want to make these docs available through the dropdown menu, put the following into the config.toml file, above all other versions (versions are linked based on order in the config file):

[[params.versions]]
harborversion = "X.Y.Z"
helmversion = "1.3"
branchname = "release-X.Y.Z"

CSS

The CSS for the site is built from Sass inputs in the assets/sass directory. There is also a small amount of JavaScript logic for the site in assets/js/app.js.

Publishing the website

The Harbor website is published automatically on the Netlify platform. Whenever changes are pushed to the master branch, the site is re-built and re-deployed, usually within about one minute.

Run the Harbor website locally

Step 1: Clone project

git clone https://github.com/goharbor/website.git
cd website

Step 2: Load documentation content

The Markdown content for the Harbor docs is drawn from the docs folder and the release-X branches. To pull that content into your local website repo:

make prepare

This copies the docs directory and the release-X branches into this repo's content folder, separated by versions, where it can be processed by Hugo.

Step 3: Install npm dependencies

npm i

Step 3: Run Hugo in server mode

make serve

This starts up the local Hugo server on http://localhost:1313. As you make changes, the site refreshes automatically in your browser.

Checking links

To run the link checker for the Harbor website:

make check-internal-links

This command builds the site (including drafts and future content), downloads the htmltest link checker into your local directory, and runs the checker in accordance with the configuration specified in .htmltest.yml. Only internal links are checked and all errors are piped to stdout.