Freeze Functionbeat docs at 8.15

[kilfoyle]

Functionbeat is deprecated in favour of Elastic Serverless Forwarder. The docs are marked as deprecated, so now we just need to freeze the builds at 8.11 until the end of time.

CI checks should pass once this one is merged: elastic/kibana#172909

Rel: elastic/ingest-docs#608
Rel: #2814 (closed in favour of this PR)

[github-actions]

A documentation preview will be available soon.

Help us out by validating the Buildkite preview and reporting issues here.
Please also be sure to double check all images to ensure they are correct in the preview.

• 🔨 Buildkite builds
• 📚 HTML diff: Buildkite - Jenkins
• 📙 Preview: Buildkite - Jenkins
• 🧪 Buildkite vs Jenkins diff

Request a new doc build by commenting

• Rebuild this PR: run docs-build
• Rebuild this PR and all Elastic docs: run docs-build rebuild

_{run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.}

_{If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.}

[nkammah]

run docs-test

[nimarezainia]

@kilfoyle @bmorelli25 is this issue still relevant?

[kilfoyle]

@nimarezainia I think it's still relevant. Since Functionbeat isn't being updated we should freeze the docs (rather than keep building new versions of the Functionbeat guide), but I can't do that until the Kibana code is updated (via elastic/kibana#172909) to remove links from the UI into the docs.

[nimarezainia]

@nimarezainia I think it's still relevant. Since Functionbeat isn't being updated we should freeze the docs (rather than keep building new versions of the Functionbeat guide), but I can't do that until the Kibana code is updated (via elastic/kibana#172909) to remove links from the UI into the docs.

@kilfoyle its now merged. thank you.

[kilfoyle]

@elasticmachine run docs-build rebuild

[kilfoyle]

I've opened this PR in the Kibana docs to try and resolve the following failing docs build CI check: elastic/kibana#192491

2024-09-10 10:28:42 EDT | INFO:build_docs:Bad cross-document links:
-- | --
  | 2024-09-10 10:28:42 EDT | INFO:build_docs:  Kibana [master]: packages/kbn-doc-links/src/get_doc_links.ts contains broken links to:
  | 2024-09-10 10:28:42 EDT | INFO:build_docs:   - en/beats/functionbeat/master
  | 2024-09-10 10:29:31 EDT | 🚨 Error: The command exited with status 255

[kilfoyle]

Unfortunately my attempt to fix this failing CI check failed.

[kilfoyle]

@elastic/docs-build-guild Would any of you be familiar with link checking specifically for the Kibana UI links? The docs-build-pr CI gives me the following error, but I have no idea how to resolve it. Scrubbing the functionbeat entry from get_doc_links.ts doesn't do the trick.

2024-09-10 10:28:42 EDT | INFO:build_docs:Bad cross-document links:
-- | --
  | 2024-09-10 10:28:42 EDT | INFO:build_docs:  Kibana [master]: packages/kbn-doc-links/src/get_doc_links.ts contains broken links to:
  | 2024-09-10 10:28:42 EDT | INFO:build_docs:   - en/beats/functionbeat/master
  | 2024-09-10 10:29:31 EDT | 🚨 Error: The command exited with status 255
  | 2024-09-10 10:29:31 EDT | user command error: exit status 255

[dedemorton]

Scrubbing the functionbeat entry from get_doc_links.ts

What did you do to scrub the entry? I still see functionbeat referenced in main: https://github.com/elastic/kibana/blob/main/packages/kbn-doc-links/src/get_doc_links.ts#L284

Assuming the code no longer references the link, then I think you just need to remove the functionbeat entries in get_doc_links.ts and probably types.ts.

The docs about the link service are here: https://docs.elastic.dev/docs/kibana-doc-links (kinda minimal, but might help you)

[dedemorton]

Implied in my comment: If the code does still include a link to the functionbeat docs, it'll need to be updated (or the link removed completely). You can do it yourself, but it might be easier to get a Kibana developer to do it.

[kilfoyle]

I've opened a Kibana issue to see if we can get Functionbeat scrubbed from the packages/kbn-doc-links/src/get_doc_links.ts file.

[kilfoyle]

I've opened a new issue specifically for the Integrations Team, since one remaining link appears to come from a Cloudwatch tutorial that uses Functionbeat.

[AndersonQ]

/test

[kilfoyle]

@elasticmachine run docs-build

[kilfoyle]

Here's one I haven't seen before:

2024-11-05 12:50:57 EST | INFO:build_docs:Error executing: node template/cli.js --template resources/web/template.html --source /tmp/docsbuild/target_repo/raw/en/beats/functionbeat/8.15 --dest /tmp/docsbuild/target_repo/html/en/beats/functionbeat/8.15
-- | --
  | 2024-11-05 12:50:57 EST | INFO:build_docs:---out---
  | 2024-11-05 12:50:57 EST | INFO:build_docs:
  | 2024-11-05 12:50:57 EST | INFO:build_docs:---err---
  | 2024-11-05 12:50:57 EST | INFO:build_docs:unhandled rejection Error: EEXIST, file already exists /tmp/docsbuild/target_repo/html/en/beats/functionbeat/8.15/images/coordinate-map.png
  | 2024-11-05 12:50:57 EST | INFO:build_docs:    at fsError (/node_modules/recursive-copy/lib/copy.js:392:14)
  | 2024-11-05 12:50:57 EST | INFO:build_docs:    at /node_modules/recursive-copy/lib/copy.js:268:11 {
  | 2024-11-05 12:50:57 EST | INFO:build_docs:  errno: 47,
  | 2024-11-05 12:50:57 EST | INFO:build_docs:  code: 'EEXIST',
  | 2024-11-05 12:50:57 EST | INFO:build_docs:  path: '/tmp/docsbuild/target_repo/html/en/beats/functionbeat/8.15/images/coordinate-map.png'
  | 2024-11-05 12:50:57 EST | INFO:build_docs:}
  | 2024-11-05 12:50:57 EST | INFO:build_docs:
  | 2024-11-05 12:50:57 EST | INFO:build_docs:---------

[kilfoyle]

@elasticmachine run docs-build

[AndersonQ]

@kilfoyle,

wild guess here, but could this error be because it's building twice for 8.15?

• once for the current branch https://github.com/elastic/docs/pull/2895/files#diff-9925a85f7cc77717016f5dc21db102f95ff353476bf96849dff5d65cb94ef02dR2280
• another for the other branches list: https://github.com/elastic/docs/pull/2895/files#diff-9925a85f7cc77717016f5dc21db102f95ff353476bf96849dff5d65cb94ef02dR2282

perhaps *stackcurrent is handled in a special way to avoid this conflict, but a regular branch isn't.

Therefore it might be worth to remove 8.15 from the branches list

[kilfoyle]

@AndersonQ Just saw your comment now. I'll give that a try.

[kilfoyle]

I think 8.15 might have appeared in the branches list twice, which would cause problems for sure. For this test I've tried removing all of these: {main: master}, 8.x, 8.16, 8.15 and freezing the build at 8.14.

[kilfoyle]

2024-11-05 16:48:04 EST | INFO:build_docs:Bad cross-document links:
-- | --
  | 2024-11-05 16:48:04 EST | INFO:build_docs:  Kibana [8.16]: packages/kbn-doc-links/src/get_doc_links.ts contains broken links to:
  | 2024-11-05 16:48:04 EST | INFO:build_docs:   - en/beats/functionbeat/8.16
  | 2024-11-05 16:48:04 EST | INFO:build_docs:  Kibana [8.x]: packages/kbn-doc-links/src/get_doc_links.ts contains broken links to:
  | 2024-11-05 16:48:04 EST | INFO:build_docs:   - en/beats/functionbeat/8.x

[karenzone]

^^ Looks like we still have a couple of instances in Kibana link service.

[karenzone]

LGTM! 🚀

[kilfoyle]

---

[lcawl]

Congrats, lgtm!