README.md

linkerd.io

Source code for the linkerd.io website.

General development instructions

1. Run the linter and checker:

   docker run \
      --mount type=bind,source="$(pwd)",target=/website --workdir=/website \
      ghcr.io/linkerd/dev:v39 sh -c ".devcontainer/on-create.sh && make lint check"

2. Install Hugo 0.119.0 to run the site locally:

   For Mac users:

   brew install hugo

   For Linux users, download the extended release of Hugo from its GitHub release page.

3. From the root /website directory, build site and run Hugo in development mode:

   hugo serve -s linkerd.io

You should see the site on localhost:1313, and it should reload automatically upon file write.

To change the way the site looks

CSS/HTML

Images and static CSS and JavaScript files are located in the static directory. These files are served as-is. Some of the site's CSS, however, is generated from Sass sources in assets/scss by Hugo. When you change those files, Hugo updates the CSS for the site automatically and refreshes the page.

The files in layouts/ are the HTML for the site (including layout/index.html for the front page.) These files are Go templates with a couple extra Hugo goodies thrown in. See the hugo documentation for details.

If you're running hugo server (see above) then updates should be reflected in your browser window via some fancy javascript magic.

run.linkerd.io

Install scripts for linkerd as well as demo applications such as emojivoto.

versioncheck.linkerd.io

Location for existing installations to check and see if they're up to date or not.

To build and serve against the latest Linkerd2 release:

make serve-versioncheck.linkerd.io

api.linkerd.io

API docs for linkerd1.

Note: this does not deploy by default as part of make publish. It needs to be released separately.

Updating docs from Linkerd

See slate documentation ./build will grab whatever's on main from slate-linkerd and add it to the public dir.

Creating a new release

1. From the linkerd.io directory, run:

   ./release-next-version <new version>

2. Run ./release-next-version <release-tag> <new version> in slate-linkerd

3. Then check locally

   make serve-api.linkerd.io

4. Finally push to production

   make deploy-api.linkerd.io

   • NB: If you're running macOS 10.14+ with ruby installed by XCode, you may have to set the SDKROOT in order to install json 1.8.3 which is a middleman dependency.

Publishing

1. Make sure your gcloud tooling is up to date:

   gcloud components update
   gcloud auth login

2. Do a dry run and make sure everything works:

   make publish DRY_RUN=true

3. Update the website:

   make publish

Notes

• This does not update api.linkerd.io, see the section for that specifically to update it.

• There is no caching in front of run.linkerd.io and versioncheck.linkerd.io. You should see updates there immediately.

• There is caching for non-html pages in front of linkerd.io. If you're updating a non-html page for linkerd.io, it might be worth flushing the cache (cloudflare) and waiting awhile.

If you have to create a new bucket

You probably won't have to do this, but if you do, don't forget to do this stuff too to set up the bucket for public serving:

gsutil defacl ch -u AllUsers:R gs://bucketname
gsutil web set -m index.html -e 404.html gs://bucketname

Verifying cache updates

Turn off all caching on all files:

gsutil -m setmeta -r -h "Cache-Control: no-cache, no-store, must-revalidate" gs://linkerd.io/

Turn caching back on:

gsutil -m setmeta -r -h "Cache-Control:" gs://linkerd.io/

Enable access logs (should only need to be run once)

gsutil logging set on -b gs://linkerd2-access-logs -o AccessLog gs://linkerd.io

Get access logs

# note: this will download ALL logs. probably not what you want.
gsutil -m rsync gs://linkerd2-access-logs logs/

Set CORS policy (should only need to be run once)

gsutil cors set versioncheck.linkerd.io.cors.json gs://versioncheck.linkerd.io