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: Updated README with trace endpoints & requirements note #872

Merged
merged 4 commits into from
Apr 7, 2022

Conversation

Imod7
Copy link
Contributor

@Imod7 Imod7 commented Mar 15, 2022

Description

Additions in the README related to :

  • the experimental trace endpoints and
  • hardware requirements of sidecar.

The hardware requirements was a question from one of the teams we support in the integration side. So I thought it might be useful to have in the README the fact that sidecar is stateless.

- Added information related to the experimental `trace` endpoints.
- Added info related to the hardware requirements.
@Imod7 Imod7 requested a review from a team as a code owner March 15, 2022 11:22
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Co-authored-by: Zeke Mostov <z.mostov@gmail.com>
@TarikGul TarikGul changed the title Updated README with trace endpoints & requirements note docs: Updated README with trace endpoints & requirements note Mar 24, 2022
- Added the memory requirements for sidecar.
- Added the specs needed if running also a node alongside sidecar.
- Added the benchmarks results from Tarik.
README.md Outdated Show resolved Hide resolved
Copy link
Member

@TarikGul TarikGul left a comment

Choose a reason for hiding this comment

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

👍

Co-authored-by: Tarik Gul <47201679+TarikGul@users.noreply.github.com>
@Imod7 Imod7 merged commit d323857 into master Apr 7, 2022
@Imod7 Imod7 deleted the domi-update-readme branch April 7, 2022 17:33
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants