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.

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

docs(update): update getting started documentation with installation guidance #7245

Merged
merged 5 commits into from
Sep 27, 2024
Merged

docs(update): update getting started documentation with installation guidance #7245

merged 5 commits into from
Sep 27, 2024

Conversation

ArturRibeiro-CX
Copy link
Contributor

@ArturRibeiro-CX ArturRibeiro-CX commented Aug 30, 2024 •
edited
Loading

Reason for Proposed Changes

  • update KICS documentation;

Proposed Changes

  • add installation guidance to the "getting started" documentation;
  • add more query information to "queries" documentation;
  • add useful links to the documentation;

I submit this contribution under the Apache-2.0 license.

@ArturRibeiro-CX ArturRibeiro-CX requested a review from a team as a code owner August 30, 2024 13:51
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Aug 30, 2024
@github-actions GitHub Actions
Copy link
Contributor

kics-logo

KICS version: v2.1.1

Category Results
CRITICAL CRITICAL 0
HIGH HIGH 0
MEDIUM MEDIUM 0
LOW LOW 0
INFO INFO 0
TRACE TRACE 0
TOTAL TOTAL 0
Metric Values
Files scanned placeholder 1
Files parsed placeholder 1
Files failed to scan placeholder 0
Total executed queries placeholder 48
Queries failed to execute placeholder 0
Execution time placeholder 0

@github-actions github-actions bot added the query New query feature label Aug 30, 2024
@ArturRibeiro-CX ArturRibeiro-CX changed the title docs(getstarted): update getting started documentation with installation guidance docs(update): update getting started documentation with installation guidance Aug 30, 2024
JulioSCX
JulioSCX approved these changes Sep 3, 2024
View reviewed changes
Copy link
Contributor

@JulioSCX JulioSCX left a comment

Choose a reason for hiding this comment

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

LGTM! Nice changes to make the docs more complete and more understandable!

@ArturRibeiro-CX ArturRibeiro-CX merged commit ad8964d into master Sep 27, 2024
26 checks passed
@ArturRibeiro-CX ArturRibeiro-CX deleted the update_docs_getting_started branch September 27, 2024 16:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cxMiguelSilva cxMiguelSilva cxMiguelSilva approved these changes

@JulioSCX JulioSCX JulioSCX approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation query New query feature
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ArturRibeiro-CX @cxMiguelSilva @JulioSCX