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

Documentation adding Questions and Configs #3975

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

stephanie0x00
Copy link
Contributor

Changes

This PR adds a description on Configs and Question objects as this was currently missing.

Issue link

n/a

Demo

n/a

QA notes

Double check if everything is correct and not missing important bits as to how this works.


Code Checklist

  • All the commits in this PR are properly PGP-signed and verified.
  • This PR only contains functionality relevant to the issue.
  • I have written unit tests for the changes or fixes I made.
  • I have checked the documentation and made changes where necessary.
  • I have performed a self-review of my code and refactored it to the best of my abilities.
  • Tickets have been created for newly discovered issues.
  • For any non-trivial functionality, I have added integration and/or end-to-end tests.
  • I have informed others of any required .env changes files if required and changed the .env-dist accordingly.
  • I have included comments in the code to elaborate on what is not self-evident from the code itself, including references to issues and discussions online, or implicit behavior of an interface.

Checklist for code reviewers:

Copy-paste the checklist from the docs/source/templates folder into your comment.


Checklist for QA:

Copy-paste the checklist from the docs/source/templates folder into your comment.

@stephanie0x00 stephanie0x00 requested a review from a team as a code owner December 17, 2024 13:41
Copy link

sonarcloud bot commented Dec 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Disallowed CSP hostnames:
De omschrijving is wat algemeen. Als gebruiker begrijp ik toch niet precies de actie die wordt verwacht, welke syntax wordt vereist en welk risico vermijden we hiermee. Worden hier scan targets vermeden? En krijg je daarmee een blinde vlek in de scan? Is het mogelijk naar een voorbeeld te verwijzen?

OOIs in headers
Wat vul je hier precies in met welke syntax leidend tot welk resultaat?

OOIs in headers
Ook niet helemaal duidelijk voor mij als eenvoudige gebruiker (zie eerdere opm. voor strekking)

typo's:

  • ... "system. FQThe new users" ... : Is FQ hier bewust toegevoegd?
  • ... "against your applied policy.." ... >> ... "against your applied policy." ...
  • ... "a form in the web interface.." ... >> ... "a form in the web interface." ...
  • ... "to set an policy" ... >> ... "to set a policy" ...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Review
Development

Successfully merging this pull request may close these issues.

2 participants