Skip to content

Clean Up Docs for Hooks esp. DD Hook#2206

Merged
Weltraumschaf merged 21 commits into
secureCodeBox:mainfrom
Weltraumschaf:issue_2098_documentation
Feb 13, 2024
Merged

Clean Up Docs for Hooks esp. DD Hook#2206
Weltraumschaf merged 21 commits into
secureCodeBox:mainfrom
Weltraumschaf:issue_2098_documentation

Conversation

@Weltraumschaf
Copy link
Copy Markdown
Member

@Weltraumschaf Weltraumschaf commented Jan 19, 2024

No description provided.

@Weltraumschaf Weltraumschaf self-assigned this Jan 19, 2024
@netlify
Copy link
Copy Markdown

netlify Bot commented Jan 19, 2024 •
edited
Loading

✅ Deploy Preview for docs-securecodebox ready!

Name Link
🔨 Latest commit 559344c
🔍 Latest deploy log https://app.netlify.com/sites/docs-securecodebox/deploys/65cb5d5887193700089a3b10
😎 Deploy Preview https://deploy-preview-2206--docs-securecodebox.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@Weltraumschaf Weltraumschaf marked this pull request as draft January 19, 2024 15:19
@Weltraumschaf Weltraumschaf added enhancement New feature or request documentation Improvements or additions to documentation labels Jan 19, 2024
@Weltraumschaf Weltraumschaf force-pushed the issue_2098_documentation branch from 94e0d0f to 0af0454 Compare January 19, 2024 15:47
@Weltraumschaf Weltraumschaf changed the title Document Hooks Minor Cleanup of Post Pro w/ Hooks How-To Jan 19, 2024
@Weltraumschaf Weltraumschaf marked this pull request as ready for review January 19, 2024 15:48
@Weltraumschaf Weltraumschaf marked this pull request as draft January 19, 2024 16:26
@Weltraumschaf Weltraumschaf changed the title Minor Cleanup of Post Pro w/ Hooks How-To Clean Up Docs for Hooks esp. DD Hook Jan 19, 2024
@Weltraumschaf Weltraumschaf force-pushed the issue_2098_documentation branch from e10ff9f to b533ed7 Compare January 19, 2024 19:17
Weltraumschaf
Weltraumschaf commented Jan 26, 2024
View reviewed changes
Comment thread hooks/persistence-defectdojo/README.md
Comment thread hooks/persistence-defectdojo/README.md
@Weltraumschaf Weltraumschaf force-pushed the issue_2098_documentation branch 4 times, most recently from 182fcc1 to 362cb6a Compare February 9, 2024 15:46
@Weltraumschaf Weltraumschaf marked this pull request as ready for review February 9, 2024 15:54
@Weltraumschaf Weltraumschaf requested a review from J12934 February 9, 2024 15:55
@Weltraumschaf Weltraumschaf force-pushed the issue_2098_documentation branch from d9232fd to 3975701 Compare February 13, 2024 10:05
@Weltraumschaf
secureCodeBox#2098 Emphasize product name
d31916e 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
@Weltraumschaf
secureCodeBox#2098 Remove leading $ from shell code
5efe35a 
To add the prompt is anoying if one want to copy paste the
command because one need to remove this character on every
copied example.

Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
@Weltraumschaf
secureCodeBox#2098 We use single line paragraphs and editor softwrap
d39a4ff 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
@Weltraumschaf
secureCodeBox#2098 We emphase names of scb core concepts
f592734 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
@Weltraumschaf
secureCodeBox#2098 In English titles are capitalized
e851835 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
@Weltraumschaf
secureCodeBox#2098 Move license tags at top of file
4671e77 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
@Weltraumschaf
secureCodeBox#2098 Apply our style guide to docs
11e3aaa 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
@Weltraumschaf
secureCodeBox#2098 Use new prefixed env var name
49a5cc7 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
@Weltraumschaf
secureCodeBox#2098 Make shell script more fail safe
5383196 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
@Weltraumschaf
secureCodeBox#2098 Add new missing env vars
ee752af 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
@Weltraumschaf
secureCodeBox#2098 Reformatting DD Persistance Hook Docs
9366471 
Accidentally did this in the wrong file in previous commits.

- We use editor softwrap, so removed unnecessary line breaks.
- Reformatted table.

Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
@Weltraumschaf
secureCodeBox#2098 Adjust Docs for Config Env Vars of DD PErsistance …
933f621 
…Hook

- Add more details about the options.
- Reformat and reword the options.
- Remove hardcoded jar version. This may change and users kann find
  it anyway in the build dir.
- Add prefixed version DEFECTDOJO_IS_DEV. Unprefixed one is deprecated.

Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
@Weltraumschaf
secureCodeBox#2098 Add Hint that Env Var is Read by Lib
a7bf787 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
@Weltraumschaf
secureCodeBox#2098 Document SCAN_NAME Env Var for DD Persistance Hook
7b86fcd 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
@Weltraumschaf
secureCodeBox#2098 Add Missing Doc for NAMESPACE Env Var to DD Hook
a4aa677 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
@Weltraumschaf
secureCodeBox#2098 Improve Hooks Documentation with Basics
d61ce12 
Simply wrap up how hooks work in general and what you do with them.

Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
@Weltraumschaf
secureCodeBox#2098 Emphasize the Product Name DefectDojo
d612b1e 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
@Weltraumschaf
secureCodeBox#2098 Emphasize the Product Name secureCodeBox
c7cf639 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
@Weltraumschaf
secureCodeBox#2098 Link to the Source Where DD Scan Types are Maintained
9de4120 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
@Weltraumschaf
secureCodeBox#2098 Add Hint that DD Persistance Hook Uses Raw Findings
d6c8194 
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
@Weltraumschaf
Revert "secureCodeBox#2098 Move license tags at top of file"
559344c 
This reverts commit 4c3b81a.
@Weltraumschaf Weltraumschaf force-pushed the issue_2098_documentation branch from 3975701 to 559344c Compare February 13, 2024 12:15
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented Feb 13, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@Weltraumschaf Weltraumschaf merged commit 0513a3b into secureCodeBox:main Feb 13, 2024
@Weltraumschaf Weltraumschaf deleted the issue_2098_documentation branch February 13, 2024 18:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@J12934 J12934 J12934 approved these changes

Assignees

@Weltraumschaf Weltraumschaf

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

secureCodeBox
Archived in project

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Weltraumschaf @J12934