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

docs: Prepared Prerequisites, Command line mode and Configuration pages #597

Merged
merged 5 commits into from
Sep 6, 2024

Conversation

o-kopysov
Copy link
Collaborator

Pull Request

Description

Current PR contains the next portion of changes in GH Pages documentation.

Structure of the website:

  • Home: index.md
  • User Guide:
    • User guide: user-guide/README.md
    • Service mode:
      • GitHub webhook configuration: user-guide/service/webhook.md
      • Run service using pre-built Docker image: user-guide/service/docker.md
      • Build and run service from the source code:
        - Prerequisites:
        - Scanner installation: user-guide/service/scanner.md
        - Database configuration: user-guide/service/database.md
        - Build and run service: user-guide/service/build-and-run.md
        - Command line mode:
        - Single scan of the pull request: user-guide/cli/cli_pr.md
        - Single scan of local files: user-guide/cli/cli_file.md
        - Configuration:
        - Configuration options: user-guide/config/options.md
        - Database customization: user-guide/config/database.md
  • Developer Guide:
    • Developer guide: dev-guide/README.md
    • Contributing guide: dev-guide/contributing.md
    • Testing policy: dev-guide/testing_policy.md
    • Code review requirements: dev-guide/code-review-requirements.md
    • API reference: dev-guide/api.md
    • Integration guide: dev-guide/integration.md
  • About:
    • License: about/license.md
    • Releases: about/releases.md

Bold means that pages are included in this pull request.

Some pages:
image

image

image

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Code cleanup/refactoring
  • Documentation update
  • This change requires a documentation update
  • CI system update
  • Test Coverage update

Signed-off-by: Oleg Kopysov <o.kopysov@samsung.com>
Signed-off-by: Oleg Kopysov <o.kopysov@samsung.com>
Signed-off-by: Oleg Kopysov <o.kopysov@samsung.com>
Signed-off-by: Oleg Kopysov <o.kopysov@samsung.com>
Signed-off-by: Oleg Kopysov <o.kopysov@samsung.com>
@o-kopysov o-kopysov added the documentation Improvements or additions to documentation label Sep 6, 2024
@o-kopysov o-kopysov added this to the v2.0.0 milestone Sep 6, 2024
@o-kopysov o-kopysov self-assigned this Sep 6, 2024
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.67%. Comparing base (99b2fb7) to head (b2f1625).

Additional details and impacted files
@@            Coverage Diff            @@
##               main     #597   +/-   ##
=========================================
  Coverage     93.67%   93.67%           
  Complexity      608      608           
=========================================
  Files            49       49           
  Lines          2104     2104           
  Branches        244      244           
=========================================
  Hits           1971     1971           
  Misses           61       61           
  Partials         72       72           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@t-naumenko t-naumenko left a comment

Choose a reason for hiding this comment

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

Great documentation improvements! Thanks!

@o-kopysov o-kopysov merged commit 5485f13 into main Sep 6, 2024
10 checks passed
@o-kopysov o-kopysov deleted the update-doc branch September 6, 2024 13:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants