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

Improvement of deployment documentation #4561

Open
SelinaBuff opened this issue Oct 17, 2024 · 0 comments
Open

Improvement of deployment documentation #4561

SelinaBuff opened this issue Oct 17, 2024 · 0 comments

Comments

@SelinaBuff
Copy link
Collaborator

Improvement of deployment documentation

Description:
We have received repeated feedback from external users that the deployment process is perceived as unclear. Many users encounter difficulties in successfully completing their own deployments. The existing guides and documentation do not seem to be sufficiently clear or structured to make the process understandable.

Issues/Observations:

  • Unclear structure of the documentation: Information is partially scattered and hard to find
  • Missing step-by-step guides for different deployment environments (e.g., Docker, Kubernetes, local installation)
  • Too few examples of common error scenarios and their solutions
  • No clear overview of system requirements and prerequisites for a successful deployment

Goal:
A more user-friendly and well-structured deployment documentation that helps both internal and external users to deploy our open-source tools quickly and easily.

See also the following discussions:
#4452
#4359

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

No branches or pull requests

1 participant