[Request] Remove Functionbeat from the kbn/doc-links package

[kilfoyle]

I'm trying to freeze the Functionbeat documentation as the product is fully deprecated.

In the elastic/docs repo, my pull request to freeze those docs fails our CI link checker, with an error complaining about an entry in packages/kbn-doc-links/src/get_doc_links.ts:

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

I opened this kibana PR to remove the relevant lines from the packages/kbn-doc-links/src/get_doc_links.ts file, but (as shown in that PR) the change failed the Kibana CI checks. I have no familiarity with that get_doc_links.ts file so I'd really appreciate if anyone can help remove the Functionbeat references, so that I can in turn can Freeze the Functionbeat docs at the current release (8.15 as of today).

[elasticmachine]

Pinging @elastic/kibana-docs (Team:Docs)

[lcawl]

I think the only thing missing doc link service wise from #192491 was to also remove that functionbeat declaration from the types.ts file. For example here:

kibana/packages/kbn-doc-links/src/types.ts

Line 243 in 3c01b13

readonly functionbeat: {

Before it can be removed, however, per DeDe's comments in elastic/docs#2895, the places in the UI that use that variable will need to be updated. From my searches, it's used here: https://github.com/elastic/kibana/blob/main/src/plugins/home/public/application/components/tutorial/replace_template_strings.js

... that config.docs.beats.functionbeat definition in turn is used in https://github.com/elastic/kibana/blob/main/src/plugins/home/server/tutorials/cloudwatch_logs/index.ts and https://github.com/elastic/kibana/blob/main/src/plugins/home/server/tutorials/instructions/functionbeat_instructions.ts

It looks like someone was trying to clean those out recently per #172909 so they might be able to help with the removal.

[lcawl]

If those Uis need to still point to Functionbeat docs, one solution might be to simply update the doc link service (in all branches after 8.15) to simply point to the last version of those docs. For example:

 functionbeat: {
      base: `${ELASTIC_WEBSITE_URL}guide/en/beats/functionbeat/8.15}`,
    },

[kilfoyle]

Thanks for the detective work @lcawl! This helps a lot.

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