Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

bug(docs): download of queries not providing all details #7150

Closed
duncanmapes opened this issue Jun 22, 2024 · 8 comments · Fixed by #7154
Closed

bug(docs): download of queries not providing all details #7150

duncanmapes opened this issue Jun 22, 2024 · 8 comments · Fixed by #7154
Assignees
Labels
bug Something isn't working community Community contribution query New query feature

Comments

@duncanmapes
Copy link

Found a bug? You're welcome to GitHub Discussions

  • Please make sure to:
    • Describe in details what the problem is
    • Attach a log file with relevant data preferably in DEBUG level (--log-level=DEBUG)
    • Attach the scanned sample files, anonymize the data if the original file cannot be provided
    • When attaching files to the issue make sure they are properly formatted

Expected Behavior

When I download "all queries" from https://docs.kics.io/latest/queries/all-queries/
I expect to get all the relevant data from the file.

Actual Behavior

I get a column (More Info) of text that says "Query details Documentation". On the website those are both links, Ideally those links would be provided in the download.

Steps to Reproduce the Problem

  1. Go to https://docs.kics.io/latest/queries/all-queries/
  2. Click download
  3. inspect CSV that is downloaded

Specifications

N/A

@duncanmapes duncanmapes added bug Something isn't working community Community contribution labels Jun 22, 2024
@github-actions github-actions bot added the query New query feature label Jun 22, 2024
@JulioSCX JulioSCX self-assigned this Jun 25, 2024
@JulioSCX JulioSCX changed the title bug(Query Download): Download of Queries not providing all details bug(docs): download of queries not providing all details Jun 25, 2024
@JulioSCX
Copy link
Contributor

Hello @duncanmapes,

Thank you for bringing this issue to our attention! We appreciate your feedback and the time you took to report it.

We're currently working on a fix and it should be up soon. We’ll keep you updated on the progress and let you know as soon as it’s resolved.

Thanks again for your support and patience!

@JulioSCX
Copy link
Contributor

Hi @duncanmapes,

The issue you reported has been resolved and merged into the master branch.

Thanks for bringing it to our attention!

If you encounter any more issues or have questions, please let us know!

@duncanmapes
Copy link
Author

Hey @JulioSCX thanks for that! When can we expect to see it deployed into the docs site?

@JulioSCX
Copy link
Contributor

JulioSCX commented Jun 26, 2024

Hey @duncanmapes ,

While I can't give you an exact date right now, we're anticipating a new release in the coming weeks. In the meantime, you can access the updated version by visiting the "development" version of our documentation.

Let me know if there's anything else you need!

@duncanmapes
Copy link
Author

Ah..of course, thanks.

@duncanmapes
Copy link
Author

@JulioSCX at the risk of being annoying...

It would be great if there was a way to grab that programmatically, the CSV or JSON were available at an endpoint, that would be ideal

@JulioSCX
Copy link
Contributor

JulioSCX commented Jul 1, 2024

We appreciate your suggestion, @duncanmapes !

Unfortunately at this time we don’t have plans to implement this feature, but we'll keep it in mind for future updates.
Thank you for your input - it helps us improve and we appreciate your support as a valued member of our community.

@JulioSCX
Copy link
Contributor

JulioSCX commented Jul 1, 2024

Hey @duncanmapes , just a quick update: a new KICS release is now out, so you should be able to download the information in the new format on the main page of the documentation!

Thank you again for participating in our community and giving us suggestions to help improve KICS!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working community Community contribution query New query feature
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants