Added troubleshooting doc for general issues faced while installing and running crAPI

OWASP / crAPI

completely ridiculous API (crAPI)

Apache License 2.0

1.13k stars 347 forks source link

Added troubleshooting doc for general issues faced while installing and running crAPI #138

Closed sanket-mundra closed 2 years ago

sanket-mundra commented 2 years ago

Refers to this issue: #117

Description

Please include a summary of the change, motivation and context.

Testing

Please describe the tests that you ran to verify your changes. Please summarize what did you test and what needs to be tested e.g. deployed and tested the service locally.

Documentation

Make sure that you have documented corresponding changes in this repository.

Checklist:

[x] My changes generate no new warnings
[x] I have added tests that prove my fix is effective or that my feature works
[x] Any dependent changes have been merged
[x] I have documented any changes if required in the docs.

sanket-mundra commented 2 years ago

Hey @JBAhire, I have created a google doc containing all the issues that I faced while installing and running crAPI. We can update it as and when we see new issues. Please have a look.

mathew-jose commented 2 years ago

The guide covers the common issues we find. @piyushroshan @JBAhire would a markdown be more preferable than a google doc.

piyushroshan commented 2 years ago

Markdown would be more preferred as other can contribute to same yet can be controlled of malicious changes

JBAhire commented 2 years ago

Yup. @sanket-mundra , can you please create a troubleshooting.md in same docs directory and put content there.

sanket-mundra commented 2 years ago

Done @piyushroshan @JBAhire

mathew-jose commented 2 years ago

The doc looks good. I am getting a 404 error when I try to click Troubleshooting guide crAPI from the Readme.

sanket-mundra commented 2 years ago

Yeah @mathew-jose, the 404 is because the link is for the troubleshooting.md file in the OWASP/crAPI repo but currently the file is in my forked repo. This error should go away once the PR is merged.