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 published Functionbeat docs at 8.10 #2814

Closed

Conversation

kilfoyle
Copy link
Contributor

@kilfoyle kilfoyle commented Nov 6, 2023

Functionbeat docs have been deprecated. This should:

  • Freeze the build at v8.10
  • Move the Functionbeat docs to the "Legacy Documentation" section.

I've removed the live: setting from conf.yaml for the Functionbeat docs, but please let me know if that's not the correct thing to do.

Rel: elastic/ingest-docs#608

@kilfoyle
Copy link
Contributor Author

kilfoyle commented Nov 6, 2023

Need to fix these:

10:23:43 INFO:build_docs:Bad cross-document links:
10:23:43 INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/beats/libbeat/8.11/getting-started.html contains broken links to:
10:23:43 INFO:build_docs:   - en/beats/functionbeat/8.11/functionbeat-installation-configuration.html
10:23:43 INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/beats/libbeat/master/getting-started.html contains broken links to:
10:23:43 INFO:build_docs:   - en/beats/functionbeat/master/functionbeat-installation-configuration.html
10:23:43 INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/elasticsearch/reference/8.11/how-monitoring-works.html contains broken links to:
10:23:43 INFO:build_docs:   - en/beats/functionbeat/8.11/monitoring.html
10:23:43 INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/elasticsearch/reference/master/how-monitoring-works.html contains broken links to:
10:23:43 INFO:build_docs:   - en/beats/functionbeat/master/monitoring.html
10:23:43 INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/starting-with-the-elasticsearch-platform-and-its-solutions/8.11/troubleshooting-and-faqs.html contains broken links to:
10:23:43 INFO:build_docs:   - en/beats/functionbeat/8.11/troubleshooting.html
10:23:43 INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/starting-with-the-elasticsearch-platform-and-its-solutions/master/troubleshooting-and-faqs.html contains broken links to:
10:23:43 INFO:build_docs:   - en/beats/functionbeat/master/troubleshooting.html
10:23:43 INFO:build_docs:  Kibana [8.11]: packages/kbn-doc-links/src/get_doc_links.ts contains broken links to:
10:23:43 INFO:build_docs:   - en/beats/functionbeat/8.11
10:23:43 INFO:build_docs:  Kibana [master]: packages/kbn-doc-links/src/get_doc_links.ts contains broken links to:
10:23:43 INFO:build_docs:   - en/beats/functionbeat/master

jrodewig
jrodewig previously approved these changes Nov 7, 2023
@bmorelli25
Copy link
Member

@dedemorton do you foresee anything that we're missing?

@jrodewig
Copy link
Contributor

jrodewig commented Nov 7, 2023

Did some digging on the broken Kibana link. It looks like this link is causing the build to break: https://github.com/elastic/kibana/blob/main/src/plugins/home/server/tutorials/cloudwatch_logs/index.ts#L40

{config.docs.beats.functionbeat} pulls its value from this line:
https://github.com/elastic/kibana/blob/main/packages/kbn-doc-links/src/get_doc_links.ts#L259

The link displays here:

Screenshot 2023-11-07 at 2 10 50 PM

It looks like that page also includes instructions for downloading Functionbeat 8.11 so we may want to follow up with the Fleet team about that page. Maybe we can remove it (and the link) entirely?

--

It's not causing the break, but we probably also want to fix this link: https://github.com/elastic/kibana/blob/main/src/plugins/home/server/tutorials/instructions/functionbeat_instructions.ts#L17

@dedemorton
Copy link
Contributor

do you foresee anything that we're missing?

@bmorelli25 I can't think of anything else aside from the links that are already breaking.

@kilfoyle
Copy link
Contributor Author

kilfoyle commented Nov 8, 2023

@elasticmachine, run elasticsearch-ci/docs

@kilfoyle kilfoyle changed the title Freeze publish Functionbeat docs at 8.10 Freeze published Functionbeat docs at 8.10 Nov 8, 2023
@kilfoyle
Copy link
Contributor Author

kilfoyle commented Nov 8, 2023

15:52:32 INFO:build_docs:Bad cross-document links:
15:52:32 INFO:build_docs:  Kibana [8.11]: packages/kbn-doc-links/src/get_doc_links.ts contains broken links to:
15:52:32 INFO:build_docs:   - en/beats/functionbeat/8.11
15:52:32 INFO:build_docs:  Kibana [master]: packages/kbn-doc-links/src/get_doc_links.ts contains broken links to:
15:52:32 INFO:build_docs:   - en/beats/functionbeat/master

I'm following up with the ingest-dev folks to see if we can get these tutorial links removed. Thanks @jrodewig for digging in to find out where they live!

For reference: https://github.com/elastic/ingest-dev/issues/1251#issuecomment-1802475095

@kilfoyle
Copy link
Contributor Author

@bmorelli25 and @dedemorton I removed you as reviewers just so that you won't keep getting those Slack notifications. It may take a long time before the tutorial links are removed.

@kilfoyle
Copy link
Contributor Author

Closing in favour of #2895

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.

4 participants