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

[Fleet] Use DocLinksService for doc links #100371

Closed
jen-huang opened this issue May 19, 2021 · 2 comments
Closed

[Fleet] Use DocLinksService for doc links #100371

jen-huang opened this issue May 19, 2021 · 2 comments
Assignees
Labels
bug Fixes for quality problems that affect the customer experience Team:Fleet Team label for Observability Data Collection Fleet team

Comments

@jen-huang
Copy link
Contributor

In Fleet, we have areas where we link to documentation without specifying version in the path (using /current/ instead). This will be a problem because users will be sent to the latest documentation instead of the version they are running.

We also have places where we use short URLs as a placeholder before docs are ready. This will run into the same problem with the user's version not being respected.

Instead, let's replace both kind of usages with real doc links (instead of short URLs) that are versioned, via DocLinksService.

@jen-huang jen-huang added bug Fixes for quality problems that affect the customer experience Team:Fleet Team label for Observability Data Collection Fleet team labels May 19, 2021
@elasticmachine
Copy link
Contributor

Pinging @elastic/fleet (Team:Fleet)

@dedemorton
Copy link
Contributor

We should also take this opportunity to refine some of the links that point to the guide. In many cases, we provide a generic link to the Fleet User Guide (mainly because the topic needed to support the UI didn't exist at the time the UI was created). We might not have coverage in all cases yet, but I think we're closer!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Fixes for quality problems that affect the customer experience Team:Fleet Team label for Observability Data Collection Fleet team
Projects
None yet
Development

No branches or pull requests

4 participants