scrumlr.io icon indicating copy to clipboard operation
scrumlr.io copied to clipboard

Improvement of deployment documentation

Open SelinaBuff opened this issue 4 months ago • 0 comments

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: https://github.com/inovex/scrumlr.io/discussions/4452 https://github.com/inovex/scrumlr.io/discussions/4359

SelinaBuff avatar Oct 17 '24 08:10 SelinaBuff