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 Home, Dev Guide and About sections #592

Merged
merged 3 commits into from
Sep 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 0 additions & 104 deletions .github/CONTRIBUTING.md

This file was deleted.

3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,6 @@ target/
LPVS/Projects/
LPVS/Results/
*.iml

# MkDocs generated website
doc/site/
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2022, Samsung Research. All rights reserved.
Copyright (c) 2022, Samsung Electronics Co., Ltd. All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
![Logo for dark mode](doc/lpvs-dark.png#gh-dark-mode-only)
![Logo for light mode](doc/lpvs-light.png#gh-light-mode-only)
![Logo for dark mode](doc/docs/img/lpvs-dark.png#gh-dark-mode-only)
![Logo for light mode](doc/docs/img/lpvs-light.png#gh-light-mode-only)

# License Pre-Validation Service

Expand Down Expand Up @@ -74,8 +74,8 @@ The _LPVS_ source code is distributed under the [MIT](https://opensource.org/lic

You are welcome to contribute to the _LPVS_ project. Contributing is a great way to practice social coding on GitHub, learn new technologies, and enhance your public portfolio. If you would like to contribute, please follow the guidelines below:

- [How to Contribute Code](.github/CONTRIBUTING.md)
- [How to Contribute Code](doc/docs/dev-guide/contributing.md)
- [How to Report a Security Vulnerability](.github/SECURITY.md)
- [Code Review Requirements](doc/code-review-requirements.md)
- [Code Review Requirements](doc/docs/dev-guide/code-review-requirements.md)

Thank you for your interest in contributing to _LPVS_! Your contributions are highly appreciated.
64 changes: 0 additions & 64 deletions doc/code-review-requirements.md

This file was deleted.

27 changes: 27 additions & 0 deletions doc/docs/about/license.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# License

The legal stuff.

---

## LPVS License (MIT)

Copyright (c) 2022, Samsung Electronics Co., Ltd. All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
31 changes: 31 additions & 0 deletions doc/docs/about/releases.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Releases

Where to get the latest released version of LPVS.

---

## Used version

You can determine your currently used version of LPVS by running the next command in console and checking the logs:

```console
$ java -jar lpvs-x.y.z.jar
```
![Version of LPVS](../img/version.png)

## Latest releases

Actual releases with release notes are available on [GitHub](https://github.com/Samsung/LPVS/releases).

## Maintenance team

The current and past members of the LPVS team.

* [@MoonkiHong](https://github.com/MoonkiHong/)
* [@tiokim](https://github.com/tiokim/)
* [@o-kopysov](https://github.com/o-kopysov/)
* [@tdrozdovsky](https://github.com/tdrozdovsky/)
* [@m-rudyk](https://github.com/m-rudyk/)
* [@v-kerimov](https://github.com/v-kerimov/)
* [@o-konoval](https://github.com/o-konoval/)
* [@t-naumenko](https://github.com/t-naumenko/)
89 changes: 89 additions & 0 deletions doc/docs/css/extra.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
div.col-md-9 h1:first-of-type {
text-align: center;
font-size: 60px;
font-weight: 300;
}

div.col-md-9>p:first-of-type {
text-align: center;
}

div.col-md-9 p.admonition-title:first-of-type {
text-align: left;
}

div.col-md-9 h1:first-of-type .headerlink {
display: none;
}

div.admonition.block>.admonition-title {
display: none;
}

.admonition.new, details.new {
color: var(--bs-success-text-emphasis);
background-color: var(--bs-success-bg-subtle);
border-color: var(--bs-success-border-subtle);
}
.admonition.example, details.example {
color: var(--bs-info-text-emphasis);
background-color: var(--bs-info-bg-subtle);
border-color: var(--bs-info-border-subtle);
}

/* Definition List styles */

dd {
padding-left: 20px;
}

.card-body svg {
width: 100%;
padding: 0 50px;
height: auto;
}

/* Homepage */

body.homepage>div.container>div.row>div.col-md-3 {
display: none;
}

body.homepage>div.container>div.row>div.col-md-9 {
margin-left: 0;
flex: 0 0 100%;
max-width: 100%;
}

/* mkdocstrings */

.doc-object {
padding-left: 10px;
border-left: 4px solid var(--bs-light-border-subtle);
}

.doc-contents .field-body p:first-of-type {
display: inline;
}

.doc-label-class-attribute,
.doc-label-instance-attribute {
display: none;
}

h2.doc-heading {
font-size: 1.5rem;
}
h3.doc-heading {
font-size: 1.4rem;
}
h4.doc-heading {
font-size: 1.3rem;
}
h5.doc-heading {
font-size: 1.2rem;
}

.doc-contents {
padding-left: 0;
}
21 changes: 21 additions & 0 deletions doc/docs/dev-guide/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Developer Guide

Extending LPVS

---

The LPVS Developer Guide provides documentation for developers and contributors.
You can jump directly to the pages listed below, or use the *next* and *previous* buttons
in the navigation bar at the top of the page to move through the documentation in order.

- [Contributing guide]
- [Testing policy]
- [Code review requirements]
- [API reference]
- [Integration guide]

[Contributing guide]: contributing.md
[Testing policy]: testing_policy.md
[Code review requirements]: code-review-requirements.md
[API reference]: api.md
[Integration guide]: integration.md
Loading
Loading