⚡️ Add missing documentation

akto-api-security / akto

Proactive, Open source API security → API discovery, Testing in CI/CD, Test Library with 150+ Tests, Add custom tests, Sensitive data exposure

https://www.akto.io/

MIT License

1.02k stars 196 forks source link

⚡️ Add missing documentation #129

Open ayushaga14 opened 1 year ago

ayushaga14 commented 1 year ago

💭 Introduction: Currently we are in process of adding more and more documentation for each of our features. We would be happy to get feedbacks on the features/sections which users are finding hard to understand, and need more documentation. Akto Documentation - https://docs.akto.io/

🎯 Requirements: Trying out Akto features.

✅ Task summary:

[ ] Ask to be assigned to the issue.
[ ] Wait to be assigned. We will try to assign in less than 2 hours.
[ ] Raise out the parts which you feel miss documentation and would like us to add the same.
[ ] Propose the changes in our documentation repo https://github.com/akto-api-security/Documentation and submit a pull request here.

🙋🏼‍♂️ Questions: If you have questions, need any help, or just want to hang out, make sure to join us on our Discord server.

theinfosecguy commented 1 year ago

For deploying on AWS & GCP, the option to One Click Deploy can also be added to the Docs. The documentation lacks installation steps for Azure. Also, Cloudflare workers are widely used nowadays adding support for workers (serverless) would also be a good point.

Ankita28g commented 1 year ago

Thanks @theinfosecguy for your inputs.

Yes you are right. Planning to add that button.
We don't support Azure deploy today.
Yes, Cloudflare addition would be awesome. Would be awesome if you create this as an issue in the repo?

theinfosecguy commented 1 year ago

Sure, here you go!

https://github.com/akto-api-security/akto/issues/188

Ankita28g commented 1 year ago

Hi @theinfosecguy let me know if you need help. :)

Ankita28g commented 1 year ago

Hi @theinfosecguy thanks for your submission in Hackfest. 🔥 We are reviewing your work. Do these two below:

Join this group on discord for discussions around prizes? 🚀 🏆 Please fill this form your PR to be considered for prizes!

Ankita28g commented 1 year ago

@theinfosecguy Add details in this form for your swags

ashutuptiwari commented 12 months ago

-->It could provide examples of how to use Akto to test for specific vulnerabilities, such as SQL injection or cross-site scripting. -->It could provide examples of how to integrate Akto with BurpSuite, Postman, or AWS. -->It could provide steps to take if you receive errors when running Akto tests. assign this to me

avneesh-akto commented 12 months ago

Assigned it to you @ashutuptiwari. Happy hacking. Please feel free to connect us on our Discord server for any doubts.

ashutuptiwari commented 12 months ago

Do i need to just raise an issue or create a PR ? @avneesh-akto

avneesh-akto commented 11 months ago

@ashutuptiwari propose the changes in our documentation repo https://github.com/akto-api-security/Documentation and submit a pull request here.

ashutuptiwari commented 11 months ago

i created a PR in the documentation repo @avneesh-akto https://github.com/akto-api-security/Documentation/pull/45

avneesh-akto commented 11 months ago

Hey @ashutuptiwari,

Just a quick heads up – your PR seems to be off the mark. I couldn't find the "Add API Endpoint" or "Generate Test Reports" buttons in Akto as per your documentation. We'd appreciate it if you could avoid using AI tools for document creation, as it could lead to some issues down the road. Thanks!