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

[Docs] Update README to minimize time from clone to running Fleet Server #3421

Open
kpollich opened this issue Apr 2, 2024 · 0 comments
Open
Labels
documentation Improvements or additions to documentation Team:Fleet Label for the Fleet team

Comments

@kpollich
Copy link
Member

kpollich commented Apr 2, 2024

Fleet Server's current README includes a lot of context related to compatibility, Elastic Agent, etc before diving into the steps needed to actually run Fleet Server.

We should adjust the README to minimize the time from cloning the repo to getting up and running, optimizing for new users onboarding to the project.

This means we should include

  • Golang requirements, setup instructions
  • Quick copy/paste commands to run Fleet Server in standalone mode over plain HTTP
  • A sanity check to verify Fleet Server is running properly (e.g. check the status API)
@kpollich kpollich added documentation Improvements or additions to documentation Team:Fleet Label for the Fleet team labels Apr 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Team:Fleet Label for the Fleet team
Projects
None yet
Development

No branches or pull requests

1 participant