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]: Add more documentation on container usage #313

Open
2 tasks
timheuer opened this issue Apr 23, 2024 · 1 comment
Open
2 tasks

[Docs]: Add more documentation on container usage #313

timheuer opened this issue Apr 23, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@timheuer
Copy link
Member

timheuer commented Apr 23, 2024

Describe the bug

The docs are targeted more at direct building/consuming of the binaries and lacking on usage/configuration of the container image. There also is no clear table-of-contents section that speaks to the container image.

Try to find information about typical run and/or configuration options of the container image.

Expected Docs

  • A section in the doc of getting started only with the container image that covers typical run/start commands in docker
  • Section in configuration of any/all environment variables that can be set on the container image that map to any of the garnet.conf settings
@Zerotask
Copy link

Additionally it would be great to have some more information about using Garnet in Kubernetes (e.g. in combination with helm charts)

@TalZaccai TalZaccai added the documentation Improvements or additions to documentation label Apr 25, 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
Projects
None yet
Development

No branches or pull requests

3 participants