crossplane
/
docs
mirror of https://github.com/crossplane/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #972 from jbw976/cleanalytics 

remove obsolete analytics
This commit is contained in:
Jared Watts 2025-08-13 18:24:50 -07:00 committed by GitHub
parent b0b75ce67b 62bdf17533
commit b652a647d2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 53 additions and 91 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

106
content/contribute/infrastructure.md
View File

@ -18,7 +18,7 @@ The Crossplane docs tools consist of:
## Netlify ## Netlify
Builds for production deploys and PR previews are automatically done by Netlify. Builds for production deploys and PR previews are automatically done by Netlify.
{{< hint "note" >}} {{< hint "note" >}}
The CNCF controls Netlify access. The CNCF controls Netlify access.
@ -31,7 +31,7 @@ Settings inside the `netlify.toml` file override any settings in the Netlify web
interface. interface.
The The
[`build`](https://github.com/crossplane/docs/blob/3e9e10671c32e368f5381d83e406e16bc38c93bc/netlify.toml#L1) [`build`](https://github.com/crossplane/docs/blob/3e9e10671c32e368f5381d83e406e16bc38c93bc/netlify.toml#L1)
directive defines what Netlify does to build the site. directive defines what Netlify does to build the site.
The The
@ -42,7 +42,7 @@ The
[`redirects`](https://github.com/crossplane/docs/blob/3e9e10671c32e368f5381d83e406e16bc38c93bc/netlify.toml#L9) [`redirects`](https://github.com/crossplane/docs/blob/3e9e10671c32e368f5381d83e406e16bc38c93bc/netlify.toml#L9)
are server side HTTP redirects for moved pages. are server side HTTP redirects for moved pages.
The [Netlify documentation](https://docs.netlify.com/configure-builds/file-based-configuration/) The [Netlify documentation](https://docs.netlify.com/configure-builds/file-based-configuration/)
has more information about configuring `netlify.toml`. has more information about configuring `netlify.toml`.
Netlify automatically detects the Netlify automatically detects the
@ -51,32 +51,32 @@ file and loads the listed NodeJS dependencies.
<!-- vale off --> <!-- vale off -->
### netlify_build.sh ### netlify_build.sh
<!-- vale on --> <!-- vale on -->
During a build Netlify runs the Bash script During a build Netlify runs the Bash script
[`netlify_build.sh`](https://github.com/crossplane/docs/blob/master/netlify_build.sh). [`netlify_build.sh`](https://github.com/crossplane/docs/blob/master/netlify_build.sh).
The script creates a new docs section called `latest` and copies the defined The script creates a new docs section called `latest` and copies the defined
`LATEST_VER` to `/latest`. `LATEST_VER` to `/latest`.
Next the script enables `writeStats` in the Hugo configuration file. Next the script enables `writeStats` in the Hugo configuration file.
Then, using the Netlify `$CONTEXT` Then, using the Netlify `$CONTEXT`
[environmental variable](https://docs.netlify.com/configure-builds/environment-variables/#build-metadata) [environmental variable](https://docs.netlify.com/configure-builds/environment-variables/#build-metadata)
Hugo runs, defining the [`BaseURL`](https://gohugo.io/methods/site/baseurl/) to Hugo runs, defining the [`BaseURL`](https://gohugo.io/methods/site/baseurl/) to
use for generating internal links. use for generating internal links.
## Hugo ## Hugo
Crossplane uses [Hugo](https://gohugo.io/), a static site generator. Crossplane uses [Hugo](https://gohugo.io/), a static site generator.
Hugo combines HTML templates, markdown content and generates static HTML Hugo combines HTML templates, markdown content and generates static HTML
content. content.
{{<hint "note" >}} {{<hint "note" >}}
The Hugo web server is only used for local development. Crossplane documentation The Hugo web server is only used for local development. Crossplane documentation
uses Netlify for hosting. uses Netlify for hosting.
Hugo only acts as an HTML compiler. Hugo only acts as an HTML compiler.
{{< /hint >}} {{< /hint >}}
Hugo influences the directory structure of the repository. Hugo influences the directory structure of the repository.
@ -101,9 +101,9 @@ The docs import _all_ Bootstrap SCSS files and rely on Hugo and PostCSS to
optimize the compiled CSS file. optimize the compiled CSS file.
The unmodified Bootstrap SCSS files are in The unmodified Bootstrap SCSS files are in
`/themes/geekboot/assets/scss/bootstrap/`. `/themes/geekboot/assets/scss/bootstrap/`.
Any docs-specific overrides are in per-element SCSS files located one directory Any docs-specific overrides are in per-element SCSS files located one directory
higher in `/themes/geekboot/assets/scss/`. higher in `/themes/geekboot/assets/scss/`.
{{<hint "important" >}} {{<hint "important" >}}
@ -111,11 +111,11 @@ Don't edit the original Bootstrap stylesheets. It makes the ability to
upgrade to future Bootstrap versions difficult or impossible. upgrade to future Bootstrap versions difficult or impossible.
{{< /hint >}} {{< /hint >}}
The file `/themes/geekboot/assets/scss/docs.scss` defines all the stylesheets The file `/themes/geekboot/assets/scss/docs.scss` defines all the stylesheets
Hugo loads and compiles. Add any new styles to the `docs.scss` file to include Hugo loads and compiles. Add any new styles to the `docs.scss` file to include
them. them.
### Color themes ### Color themes
Crossplane docs support a light and dark color theme that's applied via CSS Crossplane docs support a light and dark color theme that's applied via CSS
variables. variables.
@ -143,35 +143,35 @@ Hugo compiles the SCSS to CSS. Local development doesn't require SCSS installed.
For local development (when using `hugo server`) Hugo compiles SCSS without For local development (when using `hugo server`) Hugo compiles SCSS without
any optimizations. any optimizations.
In production, when publishing on Netlify or using In production, when publishing on Netlify or using
`hugo server --environment production`, Hugo compiles SCSS and optimizes the `hugo server --environment production`, Hugo compiles SCSS and optimizes the
CSS with [PostCSS](https://postcss.org/). CSS with [PostCSS](https://postcss.org/).
The PostCSS configuration is in `/postcss.config.js`. The PostCSS configuration is in `/postcss.config.js`.
The optimizations includes: The optimizations includes:
* [postcss-lightningcss](https://github.com/onigoetz/postcss-lightningcss) - for * [postcss-lightningcss](https://github.com/onigoetz/postcss-lightningcss) - for
building, minimizing and generating a source map. building, minimizing and generating a source map.
* [PurgeCSS](https://purgecss.com/plugins/postcss.html) - removes unused styles * [PurgeCSS](https://purgecss.com/plugins/postcss.html) - removes unused styles
to reduce the CSS file size. to reduce the CSS file size.
* [postcss-sort-media-queries](https://github.com/yunusga/postcss-sort-media-queries)- * [postcss-sort-media-queries](https://github.com/yunusga/postcss-sort-media-queries)-
to organize the output CSS for another small performance boost. to organize the output CSS for another small performance boost.
#### How optimization works #### How optimization works
Crossplane runs a Crossplane runs a
[different Hugo CSS command](https://github.com/crossplane/docs/blob/3e9e10671c32e368f5381d83e406e16bc38c93bc/themes/geekboot/layouts/partials/stylesheet-dynamic.html#L4) [different Hugo CSS command](https://github.com/crossplane/docs/blob/3e9e10671c32e368f5381d83e406e16bc38c93bc/themes/geekboot/layouts/partials/stylesheet-dynamic.html#L4)
if it's in local development or production. if it's in local development or production.
Hugo is in "production" when using `hugo` to only build HTML or with Hugo is in "production" when using `hugo` to only build HTML or with
`hugo server --environment production`. `hugo server --environment production`.
{{<hint "important" >}} {{<hint "important" >}}
Running Hugo in `production` mode requires the Hugo _extended_ version to Running Hugo in `production` mode requires the Hugo _extended_ version to
support PostCSS. support PostCSS.
Standard Hugo fails to build the documentation. Standard Hugo fails to build the documentation.
{{< /hint >}} {{< /hint >}}
<!-- vale Crossplane.Spelling = NO --> <!-- vale Crossplane.Spelling = NO -->
@ -182,15 +182,15 @@ website and only preserves the matching CSS styles. The resulting file is around
<!-- vale Crossplane.Spelling = YES --> <!-- vale Crossplane.Spelling = YES -->
Hugo generates the JSON file with the `buildStats` (or `writeStats`) Hugo generates the JSON file with the `buildStats` (or `writeStats`)
[configuration setting](https://gohugo.io/getting-started/configuration/#configure-build) [configuration setting](https://gohugo.io/getting-started/configuration/#configure-build)
enabled. enabled.
{{<hint "important" >}} {{<hint "important" >}}
Some tags or classes are dynamically created or not always enabled, like light Some tags or classes are dynamically created or not always enabled, like light
or dark mode. or dark mode.
Exclude these style sheets from CSS optimization with the Exclude these style sheets from CSS optimization with the
`purgecss start ignore` comment. `purgecss start ignore` comment.
For example, the Crossplane documentation ignores the `color-modes` style sheet. For example, the Crossplane documentation ignores the `color-modes` style sheet.
@ -210,9 +210,9 @@ Optimizing CSS locally with PostCSS requires installing extra packages.
* NPM packages defined in `/package.json` with `npm install`. * NPM packages defined in `/package.json` with `npm install`.
## JavaScript ## JavaScript
A goal of the documentation website is to use as little JavaScript as possible. A goal of the documentation website is to use as little JavaScript as possible.
Unless the script provides a significant improvement in performance, capability Unless the script provides a significant improvement in performance, capability
or user experience. or user experience.
Local development has no run-time JavaScript dependencies. To prevent Local development has no run-time JavaScript dependencies. To prevent
dependencies, making JavaScript changes requires compiling and committing to git. dependencies, making JavaScript changes requires compiling and committing to git.
@ -226,7 +226,7 @@ JavaScript filename.
{{< hint "important" >}} {{< hint "important" >}}
The JavaScript source in `/utils/webpack/src`, newly compiled JavaScript in The JavaScript source in `/utils/webpack/src`, newly compiled JavaScript in
`/themes/geekboot/assets/js` and updated `/themes/geekboot/data/assets.json` `/themes/geekboot/assets/js` and updated `/themes/geekboot/data/assets.json`
must be in git for production and preview deploys to use the changed JavaScript. must be in git for production and preview deploys to use the changed JavaScript.
{{< /hint >}} {{< /hint >}}
@ -238,13 +238,13 @@ must be in git for production and preview deploys to use the changed JavaScript.
* `globalScripts.js` is the point of entry for Webpack to determine all * `globalScripts.js` is the point of entry for Webpack to determine all
dependencies. This bundles [instant.page](https://instant.page/) and dependencies. This bundles [instant.page](https://instant.page/) and
[Bootstrap's JavaScript](https://getbootstrap.com/docs/5.2/getting-started/javascript/). [Bootstrap's JavaScript](https://getbootstrap.com/docs/5.2/getting-started/javascript/).
* `hoverHighlight.js` provides dynamic "hover to highlight" function. * `hoverHighlight.js` provides dynamic "hover to highlight" function.
* `slackNotify.js` creates the "Join Crossplane Slack" bubble on the home page. * `slackNotify.js` creates the "Join Crossplane Slack" bubble on the home page.
* `tabDeepAnchor.js` rewrites anchor links inside tabs to open a tab and present * `tabDeepAnchor.js` rewrites anchor links inside tabs to open a tab and present
the anchor. the anchor.
The `globalScripts.js` file is the entry point for Webpack. Any JavaScript The `globalScripts.js` file is the entry point for Webpack. Any JavaScript
modules or scripts must be in `globalScripts.js` to get compiled. modules or scripts must be in `globalScripts.js` to get compiled.
#### Building JavaScript #### Building JavaScript
@ -260,14 +260,14 @@ npm install
``` ```
Building JavaScript has two options: Building JavaScript has two options:
1. `npm run dev` 1. `npm run dev`
2. `npm run prod` 2. `npm run prod`
Using the `dev` argument doesn't optimize the JavaScript, simplifying Using the `dev` argument doesn't optimize the JavaScript, simplifying
debugging. debugging.
Using the `prod` argument optimizes the JavaScript but makes debugging more Using the `prod` argument optimizes the JavaScript but makes debugging more
difficult. difficult.
{{<hint "important" >}} {{<hint "important" >}}
Always use `npm run prod` to build the compiled JavaScript to use on the Always use `npm run prod` to build the compiled JavaScript to use on the
@ -301,14 +301,14 @@ webpack 5.89.0 compiled successfully in 1248 ms
[DocSearch](https://docsearch.algolia.com/) program. [DocSearch](https://docsearch.algolia.com/) program.
{{< hint note >}} {{< hint note >}}
Crossplane docs don't use the Netlify Algolia plugin and relies on the Crossplane docs don't use the Netlify Algolia plugin and relies on the
[Algolia Crawler](https://www.algolia.com/doc/tools/crawler/getting-started/overview/) to [Algolia Crawler](https://www.algolia.com/doc/tools/crawler/getting-started/overview/) to
discover new content and changes. discover new content and changes.
{{< /hint >}} {{< /hint >}}
## Sitemap and robots ## Sitemap and robots
Hugo generates the `robots.txt` Hugo generates the `robots.txt`
[automatically](https://gohugo.io/templates/robots/). [automatically](https://gohugo.io/templates/robots/).
For search engine discovery Crossplane uses a `sitemap.xml` file generated from For search engine discovery Crossplane uses a `sitemap.xml` file generated from
@ -322,21 +322,21 @@ Crossplane checks links with Hugo and
Hugo builds fail for any broken links in a Hugo `ref` shortcode. Hugo builds fail for any broken links in a Hugo `ref` shortcode.
To catch markdown links `htmltest` crawls rendered HTML and validates all To catch markdown links `htmltest` crawls rendered HTML and validates all
internal links. internal links.
On Monday a On Monday a
[GitHub Action](https://github.com/crossplane/docs/blob/master/.github/workflows/weekly-link-checker.yml) [GitHub Action](https://github.com/crossplane/docs/blob/master/.github/workflows/weekly-link-checker.yml)
runs to validate external links with `htmltest`. runs to validate external links with `htmltest`.
The configuration for `htmltest` is in The configuration for `htmltest` is in
[`/utils/htmlstest`](https://github.com/crossplane/docs/blob/master/utils/htmltest/.htmltest.yml). [`/utils/htmlstest`](https://github.com/crossplane/docs/blob/master/utils/htmltest/.htmltest.yml).
## Annotated website tree ## Annotated website tree
Expand the tab below to see an annotated `tree` output of the website repository. Expand the tab below to see an annotated `tree` output of the website repository.
{{<expand >}} {{<expand >}}
```shell ```shell
├── config.yaml # Hugo configuration file ├── config.yaml # Hugo configuration file
├── content # Root for all page content ├── content # Root for all page content
│   ├── contribute │   ├── contribute
@ -352,7 +352,7 @@ Expand the tab below to see an annotated `tree` output of the website repository
├── package.json # NodeJS dependencies ├── package.json # NodeJS dependencies
├── postcss.config.js # PostCSS configuration ├── postcss.config.js # PostCSS configuration
├── static # Legacy docs site images ├── static # Legacy docs site images
├── themes ├── themes
│   └── geekboot # The Hugo theme used by Crossplane │   └── geekboot # The Hugo theme used by Crossplane
│   ├── LICENSE-bootstrap │   ├── LICENSE-bootstrap
│   ├── LICENSE-geekdoc │   ├── LICENSE-geekdoc
@ -388,12 +388,10 @@ Expand the tab below to see an annotated `tree` output of the website repository
│   │   │   ├── master-version-alert.html # Alert box for the master version │   │   │   ├── master-version-alert.html # Alert box for the master version
│   │   │   ├── mermaid.html # Styling and JavaScript for mermaid diagrams │   │   │   ├── mermaid.html # Styling and JavaScript for mermaid diagrams
│   │   │   ├── meta-common.html # <meta> tags used on all pages │   │   │   ├── meta-common.html # <meta> tags used on all pages
│   │   │   ├── ms-clarity.html # Microsoft Clarity tags
│   │   │   ├── old-version-alert.html # Alert box for versions that aren't the latest │   │   │   ├── old-version-alert.html # Alert box for versions that aren't the latest
│   │   │   ├── preview-version-alert.html # Alert box for preview versions │   │   │   ├── preview-version-alert.html # Alert box for preview versions
│   │   │   ├── redirect.html # HTML meta redirect │   │   │   ├── redirect.html # HTML meta redirect
│   │   │   ├── release-notes.html # Release note summary page generator │   │   │   ├── release-notes.html # Release note summary page generator
│   │   │   ├── rollworks.html # Rollworks analytics tags
│   │   │   ├── scripts.html # Global JavaScript includes │   │   │   ├── scripts.html # Global JavaScript includes
│   │   │   ├── search-button.html # Algolia search button │   │   │   ├── search-button.html # Algolia search button
│   │   │   ├── sidebar # Static links in the left-side nav │   │   │   ├── sidebar # Static links in the left-side nav
@ -411,7 +409,7 @@ Expand the tab below to see an annotated `tree` output of the website repository
│   │   ├── expand.html # Expand button │   │   ├── expand.html # Expand button
│   │   ├── getCRDs.html # Generate API pages │   │   ├── getCRDs.html # Generate API pages
│   │   ├── hint.html # Hint boxes │   │   ├── hint.html # Hint boxes
│   │   ├── hover.html # Hover to highlight │   │   ├── hover.html # Hover to highlight
│   │   ├── img.html # Image optimizer │   │   ├── img.html # Image optimizer
│   │   ├── include.html # Include an external file │   │   ├── include.html # Include an external file
│   │   ├── markdown.html # Run content through the markdown engine again │   │   ├── markdown.html # Run content through the markdown engine again
@ -439,13 +437,13 @@ Expand the tab below to see an annotated `tree` output of the website repository
└── webpack # JavaScript tools └── webpack # JavaScript tools
├── package-lock.json # NodeJS dependency version lock ├── package-lock.json # NodeJS dependency version lock
├── package.json # NodeJS dependencies ├── package.json # NodeJS dependencies
├── src ├── src
│   └── js │   └── js
│   ├── bootstrap/ # Unmodified Bootstrap JavaScript │   ├── bootstrap/ # Unmodified Bootstrap JavaScript
│   ├── colorMode.js # Color mode switcher │   ├── colorMode.js # Color mode switcher
│   ├── customClipboard.js # Custom copy-to-clipboard tool │   ├── customClipboard.js # Custom copy-to-clipboard tool
│   ├── globalScripts.js # Point of entry for all scripts compiled by Webpack │   ├── globalScripts.js # Point of entry for all scripts compiled by Webpack
│   ├── hoverHighlight.js # Hover to highlight │   ├── hoverHighlight.js # Hover to highlight
│   ├── slackNotify.js # "Join Crossplane Slack" bubble │   ├── slackNotify.js # "Join Crossplane Slack" bubble
│   └── tabDeepAnchor.js # Link inside a tab │   └── tabDeepAnchor.js # Link inside a tab
└── webpack.config.js └── webpack.config.js

4
themes/geekboot/layouts/partials/analytics.html
View File

@ -1,3 +1 @@
{{ partialCached "ms-clarity" . }} {{ partialCached "google-analytics" . }}
{{ partialCached "google-analytics" . }}
{{ partialCached "rollworks" . }}

7
themes/geekboot/layouts/partials/ms-clarity.html
View File

@ -1,7 +0,0 @@
<script type="text/javascript">
(function(c,l,a,r,i,t,y){
c[a]=c[a]||function(){(c[a].q=c[a].q||[]).push(arguments)};
t=l.createElement(r);t.async=1;t.src="https://www.clarity.ms/tag/"+i;
y=l.getElementsByTagName(r)[0];y.parentNode.insertBefore(t,y);
})(window, document, "clarity", "script", "el5517lxor");
</script>

27
themes/geekboot/layouts/partials/rollworks.html
View File

@ -1,27 +0,0 @@
<script type="text/javascript">
adroll_adv_id = "B4XQTO44VJFVDGCGM332GU";
adroll_pix_id = "6ROIBHUPMVCSXN7HHIKJTK";
adroll_version = "2.0";
(function(w, d, e, o, a) {
w.__adroll_loaded = true;
w.adroll = w.adroll || [];
w.adroll.f = [ 'setProperties', 'identify', 'track' ];
var roundtripUrl = "https://s.adroll.com/j/" + adroll_adv_id
+ "/roundtrip.js";
for (a = 0; a < w.adroll.f.length; a++) {
w.adroll[w.adroll.f[a]] = w.adroll[w.adroll.f[a]] || (function(n) {
return function() {
w.adroll.push([ n, arguments ])
}
})(w.adroll.f[a])
}
e = d.createElement('script');
o = d.getElementsByTagName('script')[0];
e.async = 1;
e.src = roundtripUrl;
o.parentNode.insertBefore(e, o);
})(window, document);
adroll.track("pageView");
</script>