Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Freeze Functionbeat docs at 8.15 #2895

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

kilfoyle
Copy link
Contributor

@kilfoyle kilfoyle commented Jan 17, 2024

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)

@kilfoyle kilfoyle requested a review from a team as a code owner January 17, 2024 20:28
Copy link

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.

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.

conf.yaml Outdated Show resolved Hide resolved
Co-authored-by: Brandon Morelli <[email protected]>
@nkammah
Copy link
Contributor

nkammah commented Feb 13, 2024

run docs-test

@nimarezainia
Copy link

@kilfoyle @bmorelli25 is this issue still relevant?

@kilfoyle
Copy link
Contributor Author

kilfoyle commented Sep 3, 2024

@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
Copy link

@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 kilfoyle changed the title Freeze Functionbeat docs at 8.11 Freeze Functionbeat docs at 8.15 Sep 10, 2024
@kilfoyle kilfoyle closed this Sep 10, 2024
@kilfoyle kilfoyle reopened this Sep 10, 2024
@kilfoyle
Copy link
Contributor Author

@elasticmachine run docs-build rebuild

@kilfoyle
Copy link
Contributor Author

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
Copy link
Contributor Author

Unfortunately my attempt to fix this failing CI check failed.

@kilfoyle
Copy link
Contributor Author

@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
Copy link
Contributor

dedemorton commented Sep 10, 2024

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
Copy link
Contributor

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
Copy link
Contributor Author

Thanks @dedemorton. My attempt to fix via a Kibana PR removed the line you mentioned ( https://github.com/elastic/kibana/blob/main/packages/kbn-doc-links/src/get_doc_links.ts#L284 ) and that failed CI checks.

I think I'll just open a Kibana issue for this.

@kilfoyle
Copy link
Contributor Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants