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

Review, remove unnecessary Serverless documentation links #168172

Open
4 of 19 tasks
lcawl opened this issue Oct 6, 2023 · 1 comment
Open
4 of 19 tasks

Review, remove unnecessary Serverless documentation links #168172

lcawl opened this issue Oct 6, 2023 · 1 comment
Assignees

Comments

@lcawl
Copy link
Contributor

lcawl commented Oct 6, 2023

Relates to #167088

When I worked on moving hard-coded doc links into the doc link service (#88107) I didn't really put time into questioning whether the doc link should exist, I just fixed how it was coded.

As part of finding Serverless-specific documentation links for the keywords in kbn-doc-links, it's worth revisiting whether all of them add value. Could they be removed? Or are they indications that we need more detailed in-place help?

Though this work can affect both classic and serverless UIs, the first priority is to review the links in Serverless apps. For example, in Elasticsearch projects:

  • Discover / Log explorer
  • Dashboards
  • Project settings / Management apps
    • Advanced settings
    • API keys
    • Connectors
    • Data views
    • Files N/A
    • Index management
    • Ingest pipelines
    • Logstash pipelines
    • Machine learning
    • Maintenance windows
    • Reports N/A
    • Rules
    • Saved objects N/A
    • Tags N/A
    • Transforms
  • Visualizations

NOTE: In some cases the only place a documentation link appears is in the Help menu, but IMO those are still worth revisiting.

@elasticmachine
Copy link
Contributor

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

@lcawl lcawl self-assigned this Oct 6, 2023
@lcawl lcawl added Meta and removed Meta labels Oct 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants