Samsung / LPVS

License Pre-Validation Service analyzes which open source components and licenses are used in every patch. It returns the list of restricted licenses and the possibility of license violation on the comment with the exact code location and the open source component information.

https://samsung.github.io/LPVS/

MIT License

24 stars 25 forks source link

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

Closed o-kopysov closed 1 week ago

o-kopysov commented 1 week ago

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:

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
[X] Documentation update
[X] This change requires a documentation update
[ ] CI system update
[ ] Test Coverage update

codecov-commenter commented 1 week ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

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

Additional details and impacted files

```diff @@ 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 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.