Skip to content

Commit

Permalink
chore(website): remove obsolete mentions to netlify (#22162)
Browse files Browse the repository at this point in the history
* chore(website): remove obsolete mentions to netlify

* revert privacy.md changes

* hugo link

* Update docs/REVIEWING.md

Co-authored-by: Jen Gilbert <j.h.gilbert@gmail.com>

* md lint fix

---------

Co-authored-by: Jen Gilbert <j.h.gilbert@gmail.com>
  • Loading branch information
pront and jhgilbert authored Jan 10, 2025
1 parent f0fec05 commit bd976f1
Show file tree
Hide file tree
Showing 5 changed files with 29 additions and 1,545 deletions.
1 change: 0 additions & 1 deletion .github/workflows/regression.yml
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,6 @@ jobs:
- "website/**"
- "*.md"
- "Tiltfile"
- "netlify.toml"
- "NOTICE"
- "LICENSE-3rdparty.csv"
- "LICENSE"
Expand Down
2 changes: 1 addition & 1 deletion docs/REVIEWING.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ This checklist is specific for Vector's sinks.

#### Documentation

- [ ] Look at the doc preview on Netlify. Does it look good?
- [ ] Generate a local website: `cd website & make serve`. Does it look good?
- [ ] Is there a `cue` file linking to `base`?
- [ ] Is there a markdown file under `/website/content/en/docs/reference/configuration/sinks/`?
- [ ] Are module comments included in `mod.rs` linking to any relevant areas in the external services documentation?
Expand Down
26 changes: 5 additions & 21 deletions website/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
# The Vector website and documentation

[![Netlify Status](https://api.netlify.com/api/v1/badges/abeaffe6-d38a-4f03-8b6c-c6909e94918e/deploy-status)](https://app.netlify.com/sites/vector-project/deploys)

This directory houses all of the assets used to build Vector's website and documentation, available at [vector.dev][vector].
This directory houses all the assets used to build Vector's website and documentation, available at [vector.dev][vector].

## Prerequisites

In order to run the site [locally](#run-the-site-locally), you need to have these installed:

* The [Hugo] static site generator. Make sure to install the extended version (with [Sass] and [ESBuild] support), specifically the version specified in [`netlify.toml`](../netlify.toml).
* The [Hugo] static site generator. Refer to https://gohugo.io/installation/ for instructions.
* The CLI tool for the [CUE] configuration and validation language.
* [Node.js] and the [Yarn] package manager (for static assets and some scripting).
* [htmltest] for link checking.
Expand All @@ -17,12 +15,7 @@ In order to run the site [locally](#run-the-site-locally), you need to have thes

vector.dev is a complex site with a lot of moving parts. This section breaks the site down into some key components.

### Netlify

vector.dev is built by and hosted on the [Netlify] platform. [Deploy previews] are built for *all* pull requests to the Vector project (though this may change in the near future).
You can update site configuration and see the results of site builds on the Netlify [project page][netlify_project]. The configuration for Netlify is in the root of this repo, in the [`netlify.toml`][netlify_toml] file.

#### Branches
### Branches

The current Vector release branch (`vX.X`, for example `v0.15`) branch is used to build the "production" site at https://vector.dev. All changes should be targeted to `master`. If you want to release a website change outside of the normal release cadence, you can cherry-pick the commit to the release branch.

Expand Down Expand Up @@ -102,9 +95,8 @@ vector.dev uses two different icon sets for different purposes:

Redirects for vector.dev are defined in three difference places (depending on the use):

1. Domain-level redirects, e.g. the chat.vector.dev redirect to our Discord server, are defined in [`netlify.toml`](../netlify.toml) in the repo root.
2. Splat-style redirects (which can't be defined as Hugo aliases) are defined in [`./static/_redirects`](./static/_redirects).
3. Redirects for specific pages are defined in the [`aliases`][aliases] field in the relevant page's front matter.
1. Splat-style redirects (which can't be defined as Hugo aliases) are defined in [`./static/_redirects`](./static/_redirects).
2. Redirects for specific pages are defined in the [`aliases`][aliases] field in the relevant page's front matter.

### Link checking

Expand Down Expand Up @@ -158,10 +150,6 @@ When you make changes to the Markdown sources, Sass/CSS, or JavaScript, the site

The `title` should reflect the version, while the `weight` should be the weight of the next most recent version plus 1. The file for version 0.8.1, for example, has a weight of 8, which means the weight for version 0.8.2 (the next higher version) is 9. This metadata is necessary because Hugo can't sort semantic versions, so we need to make the ordering explicit. If Hugo ever does allow for semver sorting, we should remove the `weight`s.

## Lighthouse scores

[Lighthouse] scores for the website are produced automatically by [Netlify's Lighthouse plugin][plugin]. Those reports are available at `${ROOT}/reports/lighthouse`, where `ROOT` is the root URL for a version of the site. Thus, reports for the production version of the site would be available at https://vector.dev/reports/lighthouse. Reports are also generated for deploy previews and branch deploys.

## Known issues

* Tailwind's [typography] plugin is used to render text throughout the site. It's a decent library in general but is also rather buggy, with some rendering glitches in things like lists and tables that we've tried to compensate for in the `extend.typography` block in the [Tailwind config](./tailwind.config.js), but it will take some time to iron all of these issues out.
Expand Down Expand Up @@ -211,7 +199,6 @@ description: """
[alpine]: https://alpinejs.dev
[components]: https://vector.dev/components
[cue]: https://cuelang.org
[deploy previews]: https://docs.netlify.com/site-deploys/deploy-previews
[directory structure]: https://gohugo.io/getting-started/directory-structure
[esbuild]: https://github.com/evanw/esbuild
[guides]: https://vector.dev/guides
Expand All @@ -221,10 +208,7 @@ description: """
[hugo pipes]: https://gohugo.io/hugo-pipes
[ionicons]: https://ionic.io/ionicons
[lighthouse]: https://web.dev/performance-scoring
[netlify]: https://netlify.com
[netlify_project]: https://app.netlify.com/sites/vector-project/overview
[node.js]: https://nodejs.org
[plugin]: https://www.npmjs.com/package/@netlify/plugin-lighthouse
[postcss]: https://github.com/postcss/postcss
[purgecss]: https://purgecss.com
[react.js]: https://reactjs.org
Expand Down
8 changes: 3 additions & 5 deletions website/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -50,18 +50,16 @@
"react-spring": "^9.2.3",
"react-use": "^17.2.4",
"regenerator-runtime": "^0.13.7",
"typesense-sync": "https://s3.amazonaws.com/origin-static-assets/corp-node-packages/master/typesense-sync-v1.0.5.tgz",
"tailwindcss": "^2.2.4",
"tocbot": "^4.12.2",
"topojson-client": "^3.1.0",
"ts-node": "^9.1.1",
"typescript": "^4.1.3",
"typesense": "^1.8.2"
"typesense": "^1.8.2",
"typesense-sync": "https://s3.amazonaws.com/origin-static-assets/corp-node-packages/master/typesense-sync-v1.0.5.tgz"
},
"browserslist": [
"since 2017-06"
],
"devDependencies": {
"@netlify/plugin-lighthouse": "^2.1.2"
}
"devDependencies": {}
}
Loading

0 comments on commit bd976f1

Please sign in to comment.