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

First take on a comprehensive ingest guide #1373

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

karenzone
Copy link
Contributor

@karenzone karenzone commented Oct 7, 2024

New take on ingest story.

  • Start by trying to answer the question we hear most: "What ingest option should I use?"
  • Start with basic use cases and expand to more advanced use cases.
  • Proposal: Get to MVP quickly, and continue to iterate.

PREVIEW: https://ingest-docs_bk_1373.docs-preview.app.elstc.co/guide/en/ingest/master/ingest-guide.html

Notes

  • I've placed the content at the end of Ingest Architectures temporarily so that we can build it and see previews. This is not intended as the final destination.

Related:

@karenzone karenzone self-assigned this Oct 7, 2024
Copy link

github-actions bot commented Oct 7, 2024

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

Copy link
Contributor

mergify bot commented Oct 7, 2024

This pull request does not have a backport label. Could you fix it @karenzone? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-/d./d is the label to automatically backport to the /d./d branch. /d is the digit
    NOTE: backport-skip has been added to this pull request.

@mergify mergify bot added the backport-skip label Oct 7, 2024
@@ -0,0 +1,99 @@
[[ingest-tools]]
== Tools for ingesting data
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ordinarily, we wouldn't put forth a list of tools. Because we have quite a few ingest options and we highlight subsets throughout our doc sets, it seems helpful to list all ingest tools with descriptions in one place.

@karenzone karenzone changed the title DRAFT: First take on a comprehensive ingest guide First take on a comprehensive ingest guide Oct 29, 2024
@karenzone karenzone marked this pull request as ready for review October 29, 2024 21:45
@karenzone karenzone requested a review from a team as a code owner October 29, 2024 21:46
@karenzone
Copy link
Contributor Author

MVP proposal

This PR includes the elements that we decided were "must have" for an MVP:

  • Answer the most commonly asked question about ingesting data--"What's the best approach?"
    • Focus on starting basic, but making it clear up front that we can handle more complex scenarios if needed
  • Describe ingest options and when they should be used
  • Emphasize solutions, encouraging users to start with Agent and integrations.

Next iteration

Issue to capture feedback and ideas for next iteration: https://github.com/elastic/platform-docs-team/issues/545

@karenzone
Copy link
Contributor Author

karenzone commented Oct 29, 2024

@kilfoyle @alaudazzi @mdbirnstiehl @georgewallace, thank you for your comments in the previous markup.io review.
Now that we're in the refinement stage, please add your feedback as github suggestions and comments.
And as always, please let me know if you'd like to discuss.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant