eui icon indicating copy to clipboard operation
eui copied to clipboard

[Docs] Prevent staging deployments from being indexed in searches

Open mgadewoll opened this issue 7 months ago • 1 comments

Description

Currently PR staging links for the new EUI+ docs seem to be indexed and showing up in e.g. google searches. This leads to broken links when the instances are cleaned up. We already had that happen for the old EUI docs and fixed it in this PR by using noindex and nofollow for dev & staging.

We should update the new EUI+ docs as well to ensure the PR staging deployments are not indexed.

Acceptance criteria

  • Update docusaurus configuration to inject a meta tag for PR preview builds
  • Disable sitemap generation in PR preview builds
  • Update PR deployment pipeline to set an environment variable that lets docusaurus know it should include the meta tag (see above)

mgadewoll avatar Apr 25 '25 15:04 mgadewoll

We need to update siteConfig.js:

noIndex: https://v1.docusaurus.io/docs/en/1.11.x/site-config#noindex-boolean

weronikaolejniczak avatar May 29 '25 10:05 weronikaolejniczak