akto icon indicating copy to clipboard operation
akto copied to clipboard

Published 20 hours ago • verified publisher icon akto-api-security

⚡️ Add missing documentation

Open ayushaga14 opened this issue 1 year ago • 12 comments

💭 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.

ayushaga14 avatar Mar 06 '23 12:03 ayushaga14

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.

theinfosecguy avatar Mar 07 '23 12:03 theinfosecguy

Thanks @theinfosecguy for your inputs.

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

Ankita28g avatar Mar 07 '23 13:03 Ankita28g

Sure, here you go!

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

theinfosecguy avatar Mar 07 '23 13:03 theinfosecguy

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

Ankita28g avatar Mar 18 '23 11:03 Ankita28g

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 avatar Apr 11 '23 09:04 Ankita28g

@theinfosecguy Add details in this form for your swags

Ankita28g avatar May 20 '23 13:05 Ankita28g

-->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

ashutuptiwari avatar Oct 19 '23 19:10 ashutuptiwari

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

avneesh-akto avatar Oct 20 '23 04:10 avneesh-akto

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

ashutuptiwari avatar Oct 20 '23 06:10 ashutuptiwari

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

avneesh-akto avatar Oct 22 '23 13:10 avneesh-akto

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

ashutuptiwari avatar Oct 22 '23 20:10 ashutuptiwari

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!

avneesh-akto avatar Oct 23 '23 03:10 avneesh-akto