Skip to content

Commit ae7579e

Browse files
SherinDaher-RunaiSherinDaher-Runai
committed
Merge pull request #1453 from run-ai/Added-banner
Added banner
1 parent 50b02ce commit ae7579e

File tree

9 files changed

+102
-17
lines changed

9 files changed

+102
-17
lines changed

‎docs/Researcher/overview-researcher.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
---
22
title: Researcher Documentation Overview
33
---
4+
!!! runai "📣 The NVIDIA Run:ai docs are moving!"
5+
6+
We’ve launched a new documentation site to improve navigation, clarity, and access to the latest features starting from NVIDIA Run:ai v2.20 and above. Visit [NVIDIA Run:ai documentation](https://docshub.run.ai).
7+
8+
Documentation for versions **2.19 and below** will remain on this site.
9+
410
# Overview: Researcher Documentation
511

612
_Researchers_, or _AI practitioners_, use Run:ai to submit Workloads.

‎docs/admin/overview-administrator.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
!!! runai "📣 The NVIDIA Run:ai docs are moving!"
2+
3+
We’ve launched a new documentation site to improve navigation, clarity, and access to the latest features starting from NVIDIA Run:ai v2.20 and above. Visit [NVIDIA Run:ai documentation](https://docshub.run.ai).
4+
5+
Documentation for versions **2.19 and below** will remain on this site.
6+
17
# Overview: Infrastructure Administrator
28

39
The Infrastructure Administrator is an IT person, responsible for the installation, setup and IT maintenance of the Run:ai product.

‎docs/developer/overview-developer.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
1-
---
2-
title: Developer Documentation Overview
3-
summary: This article is an overview of the developer documentation for the Run:ai platform.
4-
authors:
5-
- Jason Novich
6-
date: 2024-Apr-10
7-
---
1+
!!! runai "📣 The NVIDIA Run:ai docs are moving!"
2+
3+
We’ve launched a new documentation site to improve navigation, clarity, and access to the latest features starting from NVIDIA Run:ai v2.20 and above. Visit [NVIDIA Run:ai documentation](https://docshub.run.ai).
4+
5+
Documentation for versions **2.19 and below** will remain on this site.
6+
7+
8+
# Overview
89

910
Developers can access Run:ai through various programmatic interfaces.
1011

‎docs/home/overview.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
!!! runai "📣 The NVIDIA Run:ai docs are moving!"
2+
3+
We’ve launched a new documentation site to improve navigation, clarity, and access to the latest features starting from NVIDIA Run:ai v2.20 and above. Visit [NVIDIA Run:ai documentation](https://docshub.run.ai).
4+
5+
Documentation for versions **2.19 and below** will remain on this site.
6+
7+
18
# Run:ai Documentation Library
29

310

‎docs/images/NVIDIA_Logo_docV1.svg

Lines changed: 15 additions & 0 deletions
Loading

‎docs/platform-admin/overview.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11

2+
!!! runai "📣 The NVIDIA Run:ai docs are moving!"
3+
4+
We’ve launched a new documentation site to improve navigation, clarity, and access to the latest features starting from NVIDIA Run:ai v2.20 and above. Visit [NVIDIA Run:ai documentation](https://docshub.run.ai).
25

6+
Documentation for versions **2.19 and below** will remain on this site.
7+
38
# Overview: Platform Administrator
49

510
The Platform Administrator is responsible for the day-to-day administration of the product.

‎docs/stylesheets/extra.css

Lines changed: 45 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44
} */
55

66
.md-header {
7-
background-color: #232837 !important;
7+
background-color: #000000 !important;
8+
top: 32px; /* This setting prevents the Material header from imposing into the space of the banner! */
9+
810
}
911

1012
.md-tabs {
@@ -71,7 +73,7 @@
7173
}
7274

7375
.custom-ticket-button {
74-
background-color: #0654FE !important; /* Change to your preferred color */
76+
background-color: #76B900 !important; /* Change to your preferred color */
7577
color: white !important;
7678
font-weight: bold;
7779
border-radius: 5px;
@@ -84,13 +86,13 @@
8486
border-top: 1px solid #1b2532 !important;
8587
}
8688

87-
/* Default logo size for desktop */
88-
html .md-header-nav__button.md-logo img,
89-
html .md-header-nav__button.md-logo svg {
90-
width: 104px !important;
91-
height: 30px !important;
89+
.md-header__button.md-logo img {
90+
max-height: 24px !important;
91+
height: auto;
92+
width: auto;
9293
}
9394

95+
9496
/* Adjust logo for tablet view */
9597
@media only screen and (max-width: 1024px) {
9698
html .md-header-nav__button.md-logo img,
@@ -193,3 +195,39 @@ html .md-nav__button.md-logo img {
193195
background: transparent;
194196
color: white;
195197
}
198+
199+
200+
/* Remove the default icon for the custom 'runai' admonition */
201+
.md-typeset .admonition.runai > .admonition-title::before,
202+
.md-typeset details.runai > summary::before {
203+
content: none !important;
204+
}
205+
206+
207+
208+
.banner {
209+
position: sticky;
210+
top: 0;
211+
z-index: 1001;
212+
background-color: #76B900;
213+
padding: 6px 16px;
214+
font-family: 'Roboto', sans-serif;
215+
font-weight: 600;
216+
font-size: 14px;
217+
color: white;
218+
display: flex;
219+
justify-content: center;
220+
align-items: center;
221+
gap: 12px;
222+
223+
}
224+
225+
.banner a {
226+
background-color: black;
227+
color: white;
228+
padding: 4px 10px;
229+
text-decoration: none;
230+
border-radius: 4px;
231+
font-size: 14px;
232+
font-weight: 600;
233+
}

‎mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
site_name: Documentation
1+
site_name: ""
22
site_url: https://docs.run.ai/
33
copyright: Copyright © 2020 - 2024 Run:ai
44
repo_url: https://github.com/run-ai/docs/
@@ -9,7 +9,7 @@ theme:
99
custom_dir: overrides
1010
language: en
1111
favicon: images/favicon.ico
12-
logo: images/logos-nvidia-runai.svg
12+
logo: images/NVIDIA_Logo_docV1.svg
1313
features:
1414
- navigation.indexes
1515
- navigation.tabs

‎overrides/main.html

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,14 @@
2020
gtag('config', 'G-F88LDKJCCH');
2121
</script>
2222
<!-- End Google Tag Manager -->
23-
23+
24+
<!-- Custom Banner -->
25+
<div class="banner">
26+
<span>Explore our new and improved documentation!</span>
27+
<a href="https://docshub.run.ai" target="_blank">Learn more</a>
28+
</div>
29+
30+
2431
{{ super() }}
2532
{% endblock %}
2633

0 commit comments

Comments
 (0)