Skip to content

[Issue]: Move Install Elastic Agents out of reference #1286

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

Open
KOTungseth opened this issue Apr 28, 2025 · 4 comments
Open

[Issue]: Move Install Elastic Agents out of reference #1286

KOTungseth opened this issue Apr 28, 2025 · 4 comments
Labels
bug Something isn't working documentation Improvements or additions to documentation Team:Obs Issues owned by the Observability Docs Team

Comments

@KOTungseth
Copy link
Contributor

KOTungseth commented Apr 28, 2025

Type of issue

Inaccurate

What documentation page is affected

https://www.elastic.co/docs/reference/fleet/install-elastic-agents

What happened?

The Install Elastic Agents content is a series of tasks. A better place for this content is Manage data since this falls under the narrative content type, not reference.

@KOTungseth KOTungseth added bug Something isn't working documentation Improvements or additions to documentation Team:Obs Issues owned by the Observability Docs Team labels Apr 28, 2025
@github-actions github-actions bot added the needs-team Issues pending triage by the Docs Team label Apr 28, 2025
@KOTungseth KOTungseth removed the needs-team Issues pending triage by the Docs Team label Apr 28, 2025
@colleenmcginnis
Copy link
Contributor

colleenmcginnis commented May 2, 2025

@shainaraskas @theletterf @kilfoyle @karenzone and I were talking about this earlier this week. When we started the migration, the IA strategy had a concept of "Manuals" that would include detailed information about a specific product that not all users will need/choose to use. That type of content ended up in "Reference" even though it might not exactly match the definition of reference content because we didn't have a "Manuals" content type. This is a larger point that should probably be revisited, but I'm not sure how much energy/capacity the team has for addressing this right now.

@theletterf
Copy link
Contributor

theletterf commented May 2, 2025

I agree that a new home should eventually be found, but this doesn't seem critical at the moment. I'm preparing to add EDOT docs as one more reference "manual" to keep things together. If direction changes or we're opposed to adding docs there, let me know as soon as possible.

Just out of curiosity, what are the most burdensome aspects of moving these docs around? Redirects and links I guess? Is this something @Mpdreamz and the team could help with eventually? (Asciidoc and rST have the concept of references after all.)

@shainaraskas
Copy link
Collaborator

shainaraskas commented May 5, 2025

Just out of curiosity, what are the most burdensome aspects of moving these docs around? Redirects and links I guess? Is this something @Mpdreamz and the team could help with eventually? (Asciidoc and rST have the concept of references after all.)

A couple of things offhand:

  • Splitting each book apart / rethinking the IA:
    • Do we split the install docs for these products into the Deploy and manage section, or do we put install docs into Manage data? Or some secret third thing?
    • Does the eventual home for the install docs need some repositioning to account for the broader scope? Upstream / downstream content changes?
    • Do any other IA changes need to be made (balancing telling a story with keeping the docs in a nice little isolated bundle)
    • Is conceptual/instructional content and reference content already nicely split, or does it need to be pulled apart/refactored?
    • Building connections across content types (because we can no longer count on the docs sitting in a big blob together)
  • Redirects currently don't work from external (we can't move things right now)
  • Link updates across docs repos are pretty cumbersome (mitigated slightly by our mini redirect implementation)

@theletterf
Copy link
Contributor

Hmm, that's perhaps the thing I would miss the most from Asciidoc / reStructuredText, that is, the ability to reference a document regardless of its location, without having to update links.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation Team:Obs Issues owned by the Observability Docs Team
Projects
None yet
Development

No branches or pull requests

4 participants