Skip to content

Commit 30f4e73

Browse files
committed
added tiles for the admin guide
1 parent 485cb89 commit 30f4e73

9 files changed

Lines changed: 68 additions & 10 deletions

File tree

docs/admin-guide.en.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: "Admin guide"
3+
hide:
4+
- toc
5+
---
6+
7+
# Admin guide
8+
9+
Select a documentation section:
10+
11+
<div class="guide-hub">
12+
<a class="guide-card" href="/on-premise/server-requirements.en/">
13+
<div class="guide-card__head">
14+
<span class="guide-card__title">Installation and maintenance</span>
15+
</div>
16+
<p class="guide-card__text">Installation requirements, deployment options, system maintenance, updates, and troubleshooting.</p>
17+
</a>
18+
19+
<a class="guide-card guide-card--general" href="/on-premise/how-to/activation.en/">
20+
<div class="guide-card__head">
21+
<span class="guide-card__title">Platform setup</span>
22+
</div>
23+
<p class="guide-card__text">System activation, access management, LDAP/OIDC configuration, and core administrative setup.</p>
24+
</a>
25+
</div>

docs/admin-guide.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: "Руководство администратора"
3+
hide:
4+
- toc
5+
---
6+
7+
# Руководство администратора
8+
9+
Выберите раздел документации:
10+
11+
<div class="guide-hub">
12+
<a class="guide-card" href="/on-premise/server-requirements/">
13+
<div class="guide-card__head">
14+
<span class="guide-card__title">Установка и эксплуатация</span>
15+
</div>
16+
<p class="guide-card__text">Требования к установке, варианты развертывания, обслуживание, обновление и диагностика.</p>
17+
</a>
18+
19+
<a class="guide-card guide-card--general" href="/on-premise/how-to/activation/">
20+
<div class="guide-card__head">
21+
<span class="guide-card__title">Настройка платформы</span>
22+
</div>
23+
<p class="guide-card__text">Активация системы, управление доступом, LDAP/OIDC и базовые административные настройки.</p>
24+
</a>
25+
</div>

docs/css/hide_lang_links.css

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,10 @@
22
display: none
33
}
44

5-
/* Hide duplicated section index link in left navigation for User guide.
6-
Keep top tabs and routing behavior intact. */
5+
/* Hide duplicated section index links in the left navigation:
6+
top-level "Admin guide" and "User guide" each have an index entry as
7+
the first child; hide those entries in all contexts. */
8+
.md-sidebar--primary input#__nav_3 ~ nav.md-nav > ul.md-nav__list > li.md-nav__item:first-child,
79
.md-sidebar--primary input#__nav_4 ~ nav.md-nav > ul.md-nav__list > li.md-nav__item:first-child {
810
display: none !important;
911
}

docs/index.en.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ hide:
2222
</a>
2323
</h2>
2424
<div class="hero-buttons">
25-
<a href="/on-premise/server-requirements/" class="btn btn-primary">Admin guide</a>
25+
<a href="/admin-guide.en/" class="btn btn-primary">Admin guide</a>
2626
<a href="/user-guide.en/" class="btn btn-secondary">User guide</a>
2727
</div>
2828
</div>

docs/index.md

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

docs/stylesheets/extra.css

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,7 @@
274274
}
275275

276276
.guide-card__title {
277-
color: var(--md-default-fg-color);
277+
color: #ffffff;
278278
font-size: 1.04rem;
279279
font-weight: 700;
280280
}
@@ -287,7 +287,7 @@
287287
}
288288

289289
.guide-card--general .guide-card__title {
290-
color: #ff3d6c;
290+
color: #ffffff;
291291
}
292292

293293
.version-tag {

docs/user-guide.en.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Select a documentation section:
1919
<img src="/assets/icons/osa.svg" alt="CodeScoring.OSA logo" />
2020
<span class="guide-card__title">CodeScoring.OSA</span>
2121
</div>
22-
<p class="guide-card__text">Open Source supply chain protection, policy enforcement, and component control.</p>
22+
<p class="guide-card__text">open source supply chain protection, policy enforcement, and component control.</p>
2323
</a>
2424

2525
<a class="guide-card" href="/sca/index.en">

docs/user-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ title: "Руководство пользователя"
1919
<img src="/assets/icons/osa.svg" alt="CodeScoring.OSA logo" />
2020
<span class="guide-card__title">CodeScoring.OSA</span>
2121
</div>
22-
<p class="guide-card__text">Защита цепочки поставок Open Source, политики и контроль компонентов в репозиториях.</p>
22+
<p class="guide-card__text">Защита цепочки поставок open source, политики и контроль компонентов в репозиториях.</p>
2323
</a>
2424

2525
<a class="guide-card" href="/sca/">

mkdocs.yml

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,8 +99,10 @@ plugins:
9999
webhooks: "Setting up webhooks"
100100
api: "Working with API"
101101
author-audit: "Calculating number of authors"
102+
admin-guide-intro: "Admin guide"
102103
user-guide: "User guide"
103104
general: "General"
105+
general-intro: "General"
104106
policies: "Security policies"
105107
policies-settings: "Managing policies"
106108
artifact-plugins: "Plugins for repositories"
@@ -262,8 +264,10 @@ plugins:
262264
webhooks: "Подключение вебхуков"
263265
api: "Работа с API"
264266
author-audit: "Аудит количества авторов"
267+
admin-guide-intro: "Руководство администратора"
265268
user-guide: "Руководство пользователя"
266269
general: "Общее"
270+
general-intro: "Общее"
267271
policies: "Политики безопасности"
268272
policies-settings: "Настройка политик"
269273
artifact-plugins: "Плагины для хранилищ"
@@ -419,6 +423,8 @@ nav:
419423
- standards: standards.md
420424
- standards: standards.en.md
421425
- admin-guide:
426+
- admin-guide-intro: admin-guide.md
427+
- admin-guide-intro: admin-guide.en.md
422428
- installation:
423429
- hardware: on-premise/server-requirements.md
424430
- hardware: on-premise/server-requirements.en.md
@@ -470,8 +476,8 @@ nav:
470476
- user-guide.md
471477
- user-guide.en.md
472478
- general:
473-
- on-premise/how-to/general/index.md
474-
- on-premise/how-to/general/index.en.md
479+
- general-intro: on-premise/how-to/general/index.md
480+
- general-intro: on-premise/how-to/general/index.en.md
475481
- user-profile: on-premise/how-to/user-profile.md
476482
- user-profile: on-premise/how-to/user-profile.en.md
477483
- policies:

0 commit comments

Comments
 (0)