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.

Sign up for GitHub

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

feat: Version switcher #875

Merged
merged 4 commits into from
Jan 10, 2024
Merged

feat: Version switcher #875

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9a00382
Add version switcher options
michael-wisely-gravwell Jan 9, 2024
bf2fbe7
Adjust navbar logo placement
michael-wisely-gravwell Jan 9, 2024
d133a14
Add LOCALE_ARCHIVE to nix shell
michael-wisely-gravwell Jan 10, 2024
d14ecbd
Fix download link
michael-wisely-gravwell Jan 10, 2024
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
11 changes: 11 additions & 0 deletions _static/css/custom.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,10 +138,21 @@ nav.bd-links p.bd-links__title {
background: unset;
}

@media (max-width: 959px) {
.navbar-brand.logo img {
height: 90%;
}
}

@media (min-width: 960px) {
.bd-page-width {
max-width: 1800px;
}

.navbar-brand.logo img {
height: 80%;
margin-top: 14px;
}
}

.bd-main .bd-content .bd-article-container {
Expand Down
8 changes: 8 additions & 0 deletions _static/versions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
[
{
"name": "v5.4.3 (latest)",
"version": "v5.4.3",
"url": "https://docs.gravwell.io/",
"preferred": true
}
]
14 changes: 14 additions & 0 deletions conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,20 @@
"git-commit-footer",
],
"navigation_with_keys": False,
#
# Version switcher
#
"switcher": {
"json_url": "https://docs.gravwell.io/_static/versions.json",
# The `version` field of each entry in verions.json must match a vN.N.N release name
"version_match": release,
},
# Show a warning banner if the user's looking at any page other than latest
"show_version_warning_banner": True,
# Don't fail to compile just because the version switcher file (json_url) isn't reachable
"check_switcher": False,
# include the version switcher next to the logo
"navbar_start": ["navbar-logo", "version-switcher"],
}

# sphinx-favicon
Expand Down
2 changes: 1 addition & 1 deletion quickstart/downloads.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,4 +56,4 @@ Some Gravwell components are distributed as optional additional installers, such
| Cloud Archive Server | <a data-bs-custom-class="hash-popover" href="https://update.gravwell.io/archive/5.4.3/installers/gravwell_cloudarchive_server_installer_5.4.3.sh">Download <i class="fa-solid fa-download"></i></a>&nbsp;&nbsp;&nbsp;<a data-bs-custom-class="hash-popover" href="javascript:void(0)" data-bs-toggle="popover" data-bs-placement="bottom" data-bs-html="true" data-bs-content='<code class="docutils literal notranslate"><span class="pre">e9c52fba87b4ee32ef4058fee1cc3ed0aa3ea8c2892ea60d05332a84a7f264f5</span></code>'>(SHA256)</a> | [Documentation](/configuration/archive) |
| Offline Replicator | <a data-bs-custom-class="hash-popover" href="https://update.gravwell.io/archive/5.4.3/installers/gravwell_offline_replication_installer_5.4.3.sh">Download <i class="fa-solid fa-download"></i></a>&nbsp;&nbsp;&nbsp;<a data-bs-custom-class="hash-popover" href="javascript:void(0)" data-bs-toggle="popover" data-bs-placement="bottom" data-bs-html="true" data-bs-content='<code class="docutils literal notranslate"><span class="pre">b8d177539a3c4a2600840e8831834da6694e62bd106102005b3887e5aa6bb884</span></code>'>(SHA256)</a> | [Documentation](/configuration/replication) |
| Load Balancer | <a data-bs-custom-class="hash-popover" href="https://update.gravwell.io/archive/5.4.3/installers/gravwell_loadbalancer_installer_5.4.3.sh">Download <i class="fa-solid fa-download"></i></a>&nbsp;&nbsp;&nbsp;<a data-bs-custom-class="hash-popover" href="javascript:void(0)" data-bs-toggle="popover" data-bs-placement="bottom" data-bs-html="true" data-bs-content='<code class="docutils literal notranslate"><span class="pre">29bb25bb5e5a6f87333acb2baf94274eae5b96edf6ea523f8690e2a9f40faae1</span></code>'>(SHA256)</a> | [Documentation](/distributed/loadbalancer) |
| Gravwell Tools | <a data-bs-custom-class="hash-popover" href="https://update.gravwell.io/archive/5.4.3/installers/gravwell_tools_5.4.3.sh"><i class="fa-solid fa-download">Download </i></a>&nbsp;&nbsp;&nbsp;<a data-bs-custom-class="hash-popover" href="javascript:void(0)" data-bs-toggle="popover" data-bs-placement="bottom" data-bs-html="true" data-bs-content='<code class="docutils literal notranslate"><span class="pre">a1f5d2e2270c811372350fb198d1666a220e45cf639e66961f8c96ce8b1965dd</span></code>'>(SHA256)</a> | [Documentation](/tools/tools)|
| Gravwell Tools | <a data-bs-custom-class="hash-popover" href="https://update.gravwell.io/archive/5.4.3/installers/gravwell_tools_5.4.3.sh">Download <i class="fa-solid fa-download"></i></a>&nbsp;&nbsp;&nbsp;<a data-bs-custom-class="hash-popover" href="javascript:void(0)" data-bs-toggle="popover" data-bs-placement="bottom" data-bs-html="true" data-bs-content='<code class="docutils literal notranslate"><span class="pre">a1f5d2e2270c811372350fb198d1666a220e45cf639e66961f8c96ce8b1965dd</span></code>'>(SHA256)</a> | [Documentation](/tools/tools)|
5 changes: 4 additions & 1 deletion shell.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
with (import ./packages.nix);
pkgs.mkShell { buildInputs = chosenPackages ++ [ pkgs.coreutils ]; }
pkgs.mkShell {
LOCALE_ARCHIVE = "${pkgs.glibcLocales}/lib/locale/locale-archive";
buildInputs = chosenPackages ++ [ pkgs.coreutils ];
}