Skip to content

#2135 Change documentation partially #2239

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Feb 2, 2024
Merged

#2135 Change documentation partially #2239

merged 2 commits into from
Feb 2, 2024

Conversation

BorisShek
Copy link
Contributor

@BorisShek BorisShek commented Jan 30, 2024 •
edited
Loading

Revise 'Getting Started', 'How To's', and 'Contributing' sections in the documentation. In 'Contributing' -> 'Local Scanner and Hook Deployment', remove references to 'Minikube' and update example shell code. Also, add a new contributor Boris Shek.

Description

Checklist

  • Test your changes as thoroughly as possible before you commit them. Preferably, automate your test by unit/integration tests.
  • Make sure that all your commits are signed-off and that you are added to the Contributors file.
  • Make sure that all CI finish successfully.
  • Optional (but appreciated): Make sure that all commits are Verified.

@BorisShek
secureCodeBox#2135 Change documentation partially
83c275d 
Revise 'Getting Started', 'How To's', and 'Contributing' sections in the documentation.
In 'Contributing' -> 'Local Scanner and Hook Deployment', remove references to 'Minikube' and update example shell code.
Also, add a new contributor Boris Shek.

Signed-off-by: Boris Shek <boris.shek@iteratec.com>
@netlify Netlify
Copy link

netlify bot commented Jan 30, 2024 •
edited
Loading

✅ Deploy Preview for docs-securecodebox ready!

Name Link
🔨 Latest commit 4a46570
🔍 Latest deploy log https://app.netlify.com/sites/docs-securecodebox/deploys/65bbe99bcbac8d0008402998
😎 Deploy Preview https://deploy-preview-2239--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.

@BorisShek BorisShek linked an issue Jan 30, 2024 that may be closed by this pull request
📚 Recurring documentation issue #2135
Closed
J12934
J12934 approved these changes Jan 31, 2024
View reviewed changes
Copy link
Member

@J12934 J12934 left a comment

Choose a reason for hiding this comment

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

Nice awesome (or worrying :D) that you were able to find this many typos & grammar misstakes 👍

One suggestion to tweak on the local deployment guide. Already approved so that you can merge this ASAP after that :)

@BorisShek
secureCodeBox#2135 Docs: Refine local-deployment guide
4a46570 
Include guide for setting up a local Kubernetes cluster using 'kind' in the local-deployment section of the documentation.

Signed-off-by: Boris Shek <boris.shek@iteratec.com>
@sonarqubecloud SonarQubeCloud
Copy link

sonarqubecloud bot commented Feb 1, 2024

Quality Gate Passed Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@Weltraumschaf Weltraumschaf added the documentation Improvements or additions to documentation label Feb 2, 2024
@Weltraumschaf Weltraumschaf merged commit fbe3a02 into secureCodeBox:main Feb 2, 2024
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

@BorisShek BorisShek

Labels
documentation Improvements or additions to documentation
Projects
secureCodeBox
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

📚 Recurring documentation issue
3 participants
@BorisShek @J12934 @Weltraumschaf