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

Extend context-aware documentation links to support other flavors #176971

Closed
dedemorton opened this issue Feb 14, 2024 · 6 comments
Closed

Extend context-aware documentation links to support other flavors #176971

dedemorton opened this issue Feb 14, 2024 · 6 comments
Labels
docs Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc

Comments

@dedemorton
Copy link
Contributor

Describe the feature:

Relates to the kbn-doc-links service, implemented in #123818

In #167088, we added the ability to add context-aware documentation links for serverless.

We have a few instances where we would like to override the doc links to point to docs for a specific serverless solution. For example, in Observability serverless, the help link under the Dashboards UI should point to https://docs.elastic.co/serverless/observability/dashboards. In Elasticsearch serverless, it should point to https://docs.elastic.co/serverless/elasticsearch/explore-your-data-visualize-your-data. But because the UI is shared, we currently can't override the help link for each solution.

There is also an emerging requirement to override doc links when a UI appears in cloud, so we might need to extend the doc link service with additional "flavors". cc @florent-leborgne for more detail about this requirement.

Describe a specific use case for the feature:

Users accessing the documentation should be presented with the correct documentation for the solution they are using.

@dedemorton dedemorton added Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc docs labels Feb 14, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-core (Team:Core)

@dedemorton
Copy link
Contributor Author

Looks like there is a request to add cloud-aware links here: #176997

@pgayvallet
Copy link
Contributor

We have a few instances where we would like to override the doc links to point to docs for a specific serverless solution

If I do understand the need, this may require slightly more work than #167088, as technically the serverless project type is not really a concrete concept in Core at the moment.

@pgayvallet
Copy link
Contributor

@dedemorton is that still something you would need?

@dedemorton
Copy link
Contributor Author

@pgayvallet Good question. The answer is a little complicated. After we migrate our docs to docsmobile (aka "next docs"), we plan to remove duplicated content where possible, which means we might no long need the ability to override links at a solution level. However this plan is still a WIP. Since my team (Observability docs) only has a couple instances where we need to override the link, it's not a high priority for us right now.

@florent-leborgne What do you think?

@dedemorton
Copy link
Contributor Author

Closing because this work will probably not be required given our evolving docs IA plans.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc
Projects
None yet
Development

No branches or pull requests

3 participants