Skip to content

Add support documentation explaining the issue submission process #52

@teon

Description

@teon

Right now all users when reporing problems do it in their own way. Then we are constantly asking them to add the info about the operating system, component version etc.

Now with DefGuard/defguard#1319 ready, we can standardize the process as our logs should have all those informations.

Please do the following:

  • Change the "Resources" seciton in docs to "Support"
  • Move it before Tutorials
  • Add a document "How to submit an issue" explaining that we are requiring to submit all logs from all components, that they will have the os, version, version of the components already,.
  • Add info that before submitting the bug they need to change LOG to DEBUG, reproduce the issue and then submit the logs of all components - and how to do that in each component
  • Add an example

This will be a great test of this new functionality with helping us support - and taking this issue into consideration it might influence how: DefGuard/defguard#1319 is implemented...

Depends on: DefGuard/defguard#1319

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

Status

Ready to release

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions