Skip to content

Commit 485cb89

Browse files
amaksimovvamaksimovv
committed
added tiles for the user guide
1 parent df13305 commit 485cb89

9 files changed

Lines changed: 229 additions & 6 deletions

File tree

‎docs/css/hide_lang_links.css‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
11
.i18n-link {
22
display: none
3-
}
3+
}
4+
5+
/* Hide duplicated section index link in left navigation for User guide.
6+
Keep top tabs and routing behavior intact. */
7+
.md-sidebar--primary input#__nav_4 ~ nav.md-nav > ul.md-nav__list > li.md-nav__item:first-child {
8+
display: none !important;
9+
}

‎docs/index.en.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ hide:
2323
</h2>
2424
<div class="hero-buttons">
2525
<a href="/on-premise/server-requirements/" class="btn btn-primary">Admin guide</a>
26-
<a href="/osa/" class="btn btn-secondary">User guide</a>
26+
<a href="/user-guide.en/" class="btn btn-secondary">User guide</a>
2727
</div>
2828
</div>
2929
</div>
@@ -45,4 +45,4 @@ button[aria-label="Download PDF"],
4545
.md-page__pdf {
4646
display: none !important;
4747
}
48-
</style>
48+
</style>

‎docs/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ hide:
2323
</h2>
2424
<div class="hero-buttons">
2525
<a href="/on-premise/server-requirements/" class="btn btn-primary">Руководство администратора</a>
26-
<a href="/osa/" class="btn btn-secondary">Руководство пользователя</a>
26+
<a href="/user-guide/" class="btn btn-secondary">Руководство пользователя</a>
2727
</div>
2828
</div>
2929
</div>

‎docs/on-premise/how-to/general/index.en.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
hide:
3+
- footer
4+
---
5+
6+
# General
7+
8+
This section covers core platform workflows:
9+
10+
- user profile configuration;
11+
- creation and setup of security policies;
12+
- VCS integration and project management;
13+
- advanced setup (proprietors, notifications, audit log, metrics, webhooks, API).
14+
15+
Use the left navigation to open the required subsection.

‎docs/on-premise/how-to/general/index.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
hide:
3+
- footer
4+
---
5+
6+
# Общее
7+
8+
Раздел содержит базовые сценарии работы с платформой:
9+
10+
- настройка профиля пользователя;
11+
- создание и настройка политик безопасности;
12+
- подключение VCS и управление проектами;
13+
- расширенные настройки (подразделения, уведомления, аудит-лог, метрики, webhooks, API).
14+
15+
Используйте навигацию слева для перехода к нужному подразделу.

‎docs/stylesheets/extra.css‎

Lines changed: 88 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -236,6 +236,60 @@
236236
animation: heart 1000ms infinite;
237237
}
238238

239+
.guide-hub {
240+
display: grid;
241+
grid-template-columns: repeat(auto-fit, minmax(220px, 1fr));
242+
gap: 1rem;
243+
margin-top: 1.25rem;
244+
}
245+
246+
.guide-card {
247+
display: flex;
248+
flex-direction: column;
249+
justify-content: space-between;
250+
min-height: 165px;
251+
padding: 1rem;
252+
border-radius: 12px;
253+
border: 1px solid rgba(255, 61, 108, 0.35);
254+
background: linear-gradient(160deg, rgba(255, 61, 108, 0.08), rgba(255, 61, 108, 0.02));
255+
text-decoration: none !important;
256+
transition: transform 0.16s ease, box-shadow 0.16s ease, border-color 0.16s ease;
257+
}
258+
259+
.guide-card:hover {
260+
transform: translateY(-2px);
261+
border-color: rgba(255, 61, 108, 0.7);
262+
box-shadow: 0 10px 22px rgba(255, 61, 108, 0.16);
263+
}
264+
265+
.guide-card__head {
266+
display: flex;
267+
align-items: center;
268+
gap: 0.65rem;
269+
}
270+
271+
.guide-card__head img {
272+
width: 28px;
273+
height: 28px;
274+
}
275+
276+
.guide-card__title {
277+
color: var(--md-default-fg-color);
278+
font-size: 1.04rem;
279+
font-weight: 700;
280+
}
281+
282+
.guide-card__text {
283+
margin: 0.65rem 0 0;
284+
color: var(--md-default-fg-color--light);
285+
font-size: 0.82rem;
286+
line-height: 1.45;
287+
}
288+
289+
.guide-card--general .guide-card__title {
290+
color: #ff3d6c;
291+
}
292+
239293
.version-tag {
240294
display: inline-flex;
241295
align-items: center;
@@ -361,4 +415,37 @@
361415

362416
.data-tag {
363417
--tag-color: #8b5cf6;
364-
}
418+
}
419+
420+
@media (max-width: 900px) {
421+
.guide-hub {
422+
grid-template-columns: repeat(2, minmax(0, 1fr));
423+
}
424+
}
425+
426+
@media (max-width: 640px) {
427+
.guide-hub {
428+
grid-template-columns: 1fr;
429+
gap: 0.75rem;
430+
margin-top: 1rem;
431+
}
432+
433+
.guide-card {
434+
min-height: auto;
435+
padding: 0.9rem;
436+
}
437+
438+
.guide-card__head img {
439+
width: 24px;
440+
height: 24px;
441+
}
442+
443+
.guide-card__title {
444+
font-size: 1rem;
445+
}
446+
447+
.guide-card__text {
448+
font-size: 0.95rem;
449+
line-height: 1.4;
450+
}
451+
}

‎docs/user-guide.en.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
title: "User guide"
3+
---
4+
5+
# User guide
6+
7+
Select a documentation section:
8+
9+
<div class="guide-hub">
10+
<a class="guide-card guide-card--general" href="/on-premise/how-to/general.en/">
11+
<div class="guide-card__head">
12+
<span class="guide-card__title">General</span>
13+
</div>
14+
<p class="guide-card__text">Core platform setup, user management, policies, notifications, and API usage.</p>
15+
</a>
16+
17+
<a class="guide-card" href="/osa/index.en">
18+
<div class="guide-card__head">
19+
<img src="/assets/icons/osa.svg" alt="CodeScoring.OSA logo" />
20+
<span class="guide-card__title">CodeScoring.OSA</span>
21+
</div>
22+
<p class="guide-card__text">Open Source supply chain protection, policy enforcement, and component control.</p>
23+
</a>
24+
25+
<a class="guide-card" href="/sca/index.en">
26+
<div class="guide-card__head">
27+
<img src="/assets/icons/sca.svg" alt="CodeScoring.SCA logo" />
28+
<span class="guide-card__title">CodeScoring.SCA</span>
29+
</div>
30+
<p class="guide-card__text">Dependency composition analysis, vulnerabilities, licenses, reports, and SBOM.</p>
31+
</a>
32+
33+
<a class="guide-card" href="/secrets/index.en">
34+
<div class="guide-card__head">
35+
<img src="/assets/icons/secrets.svg" alt="CodeScoring.Secrets logo" />
36+
<span class="guide-card__title">CodeScoring.Secrets</span>
37+
</div>
38+
<p class="guide-card__text">Secret detection in source code, findings triage, and scanning setup scenarios.</p>
39+
</a>
40+
41+
<a class="guide-card" href="/tqi/index.en">
42+
<div class="guide-card__head">
43+
<img src="/assets/icons/tqi.svg" alt="CodeScoring.TQI logo" />
44+
<span class="guide-card__title">CodeScoring.TQI</span>
45+
</div>
46+
<p class="guide-card__text">Development quality analytics, technical debt metrics, author profiles, and clones.</p>
47+
</a>
48+
</div>

‎docs/user-guide.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
title: "Руководство пользователя"
3+
---
4+
5+
# Руководство пользователя
6+
7+
Выберите раздел документации:
8+
9+
<div class="guide-hub">
10+
<a class="guide-card guide-card--general" href="/on-premise/how-to/general/">
11+
<div class="guide-card__head">
12+
<span class="guide-card__title">Общее</span>
13+
</div>
14+
<p class="guide-card__text">Базовые настройки платформы, управление пользователями, политиками, уведомлениями и API.</p>
15+
</a>
16+
17+
<a class="guide-card" href="/osa/">
18+
<div class="guide-card__head">
19+
<img src="/assets/icons/osa.svg" alt="CodeScoring.OSA logo" />
20+
<span class="guide-card__title">CodeScoring.OSA</span>
21+
</div>
22+
<p class="guide-card__text">Защита цепочки поставок Open Source, политики и контроль компонентов в репозиториях.</p>
23+
</a>
24+
25+
<a class="guide-card" href="/sca/">
26+
<div class="guide-card__head">
27+
<img src="/assets/icons/sca.svg" alt="CodeScoring.SCA logo" />
28+
<span class="guide-card__title">CodeScoring.SCA</span>
29+
</div>
30+
<p class="guide-card__text">Композиционный анализ зависимостей, уязвимости, лицензии, отчеты и SBOM.</p>
31+
</a>
32+
33+
<a class="guide-card" href="/secrets/">
34+
<div class="guide-card__head">
35+
<img src="/assets/icons/secrets.svg" alt="CodeScoring.Secrets logo" />
36+
<span class="guide-card__title">CodeScoring.Secrets</span>
37+
</div>
38+
<p class="guide-card__text">Поиск секретов в коде, работа с находками и настройка сценариев сканирования.</p>
39+
</a>
40+
41+
<a class="guide-card" href="/tqi/">
42+
<div class="guide-card__head">
43+
<img src="/assets/icons/tqi.svg" alt="CodeScoring.TQI logo" />
44+
<span class="guide-card__title">CodeScoring.TQI</span>
45+
</div>
46+
<p class="guide-card__text">Анализ качества разработки, метрики технического долга, авторы и дубликаты кода.</p>
47+
</a>
48+
</div>

‎mkdocs.yml‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -467,7 +467,11 @@ nav:
467467
- oidc: on-premise/how-to/oidc.md
468468
- oidc: on-premise/how-to/oidc.en.md
469469
- user-guide:
470+
- user-guide.md
471+
- user-guide.en.md
470472
- general:
473+
- on-premise/how-to/general/index.md
474+
- on-premise/how-to/general/index.en.md
471475
- user-profile: on-premise/how-to/user-profile.md
472476
- user-profile: on-premise/how-to/user-profile.en.md
473477
- policies:
@@ -748,4 +752,4 @@ extra:
748752
- ru:
749753
site_name: "Документация CodeScoring"
750754
- en:
751-
site_name: "CodeScoring Documentation"
755+
site_name: "CodeScoring Documentation"

0 commit comments

Comments
 (0)