Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

linkerd.io rebuild #1860

Merged
merged 10 commits into from
Oct 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion .devcontainer/on-create.sh
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ set -euo pipefail
cd $(mktemp -d)

# hugo
scurl -O https://github.com/gohugoio/hugo/releases/download/v0.126.1/hugo_extended_0.126.1_linux-amd64.deb
scurl -O https://github.com/gohugoio/hugo/releases/download/v0.136.5/hugo_extended_0.136.5_linux-amd64.deb
sudo dpkg -i hugo*.deb
rm hugo*.deb

Expand Down
13 changes: 2 additions & 11 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,7 @@ shellcheck:
@# lint the install scripts
shellcheck run.linkerd.io/public/install* \
api.linkerd.io/build \
linkerd.io/build \
linkerd.io/release-next-version
linkerd.io/build

.PHONY: test-ci
test-ci:
Expand All @@ -112,7 +111,7 @@ serve-api.linkerd.io: build-api.linkerd.io
&& python3 -m http.server 9999

.PHONY: build-linkerd.io
build-linkerd.io: build-release-matrix get-versions tmp/linkerd.io
build-linkerd.io: get-versions tmp/linkerd.io
@# Build linkerd.io
ifndef HAS_HUGO
@printf "Install hugo first. For OSX: brew install hugo\n"; exit 1
Expand Down Expand Up @@ -140,14 +139,6 @@ replace-env-%: has-env-% tmp-sites
sed 's/$*/$($*)/g' < $$fname > /tmp/__sed && mv /tmp/__sed $$fname; \
done

.PHONY: build-release-matrix
build-release-matrix:
@# Build release matrix
./bin/generate_release_matrix.py --release_type=stable --format=json > linkerd.io/data/releases/release_matrix.json
./bin/generate_release_matrix.py --release_type=stable --format=yaml > linkerd.io/content/releases/release_matrix.yaml
cp linkerd.io/data/releases/release_matrix.json linkerd.io/content/releases/release_matrix.json


.PHONY: has-env-%
has-env-%:
@if [ ! $${$*:-} ]; then printf "You must define: $*\n" && exit 1; fi
Expand Down
39 changes: 6 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Source code for the linkerd.io website.
ghcr.io/linkerd/dev:v39 sh -c ".devcontainer/on-create.sh && make lint check"
```

1. Install Hugo 0.119.0 to run the site locally:
1. Install Hugo to run the site locally:

For Mac users:

Expand All @@ -27,34 +27,19 @@ Source code for the linkerd.io website.
1. From the root `/website` directory, build site and run Hugo in development mode:

```bash
hugo serve -s linkerd.io
hugo server -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](https://sass-lang.com) 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](http://gohugo.io/templates/overview/) for details.

If you're running `hugo server` (see above) then updates should be reflected in
your browser window via some fancy javascript magic.
[Learn more](https://github.com/linkerd/website/blob/main/linkerd.io/README.md/)
about how to add content to linkerd.io.

## [run.linkerd.io](run.linkerd.io)

Install scripts for linkerd as well as demo applications such as
[emojivoto][emojivoto].
[emojivoto](https://github.com/BuoyantIO/emojivoto).

## [versioncheck.linkerd.io](versioncheck.linkerd.io)

Expand All @@ -74,21 +59,13 @@ 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](slate-linkerd) `./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](linkerd.io) directory, run:

```bash
./release-next-version <new version>
```

1. Run `./release-next-version <release-tag> <new version>` in
[slate-linkerd](https://github.com/BuoyantIO/slate-linkerd)
[https://github.com/BuoyantIO/slate-linkerd/blob/master/BUOYANT-README.md](github.com/BuoyantIO/slate-linkerd)

1. Then check locally

Expand All @@ -106,7 +83,6 @@ main from slate-linkerd and add it to the public dir.
may have to [set the SDKROOT](https://github.com/castwide/vscode-solargraph/issues/78#issuecomment-552675511)
in order to install `json 1.8.3` which is a `middleman` dependency.


## Publishing

1. Make sure your gcloud tooling is up to date:
Expand Down Expand Up @@ -182,6 +158,3 @@ gsutil -m rsync gs://linkerd2-access-logs logs/
```bash
gsutil cors set versioncheck.linkerd.io.cors.json gs://versioncheck.linkerd.io
```

[emojivoto]: https://github.com/BuoyantIO/emojivoto
[slate-linkerd]: https://github.com/BuoyantIO/slate-linkerd/blob/master/BUOYANT-README.md
Loading
Loading