Skip to content

chore: Improve content structure of website #458

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

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open
1 change: 1 addition & 0 deletions .github/config/wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,7 @@ filesystem
filesytem
finalizer
finalizers
fluxcd
fluxdeployer
fluxdeployers
fluxdeployerspec
Expand Down
Binary file removed assets/images/roadmap_Q2-2024.png
Binary file not shown.
Binary file added assets/images/roadmap_Q2-2025.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
63 changes: 63 additions & 0 deletions assets/scss/common/_custom.scss
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,66 @@
display: inline !important;
white-space: nowrap !important;
}

/* ================================
Section-specific layout overrides
================================ */

@media (min-width: 1200px) {
/* — COMMUNITY PAGE — */
body.section-community {
/* Hide the left sidebar */
.docs-sidebar {
display: none !important;
}
/* Widen the main content */
.docs-content {
flex: 0 0 85% !important;
max-width: 85% !important;
margin: 0 1rem !important;
padding: 1rem !important;
}
/* Narrow the TOC and keep it visible */
.docs-toc {
display: block !important;
flex: 0 0 15% !important;
max-width: 15% !important;
margin: 0 1rem !important;
padding-top: 1rem !important;
}
}

/* — ROADMAP PAGE — */
body.section-roadmap {
/* Hide sidebar and TOC entirely */
.docs-sidebar,
.docs-toc {
display: none !important;
}
/* Make the content almost full-width */
.docs-content {
flex: 0 0 90% !important;
max-width: 90% !important;
margin: 0 auto !important;
padding: 1rem !important;
}
}
}

/* Mobile fallback: both pages full-width below 768px */
@media (max-width: 768px) {
body.section-community .docs-content,
body.section-roadmap .docs-content {
flex: 0 0 100% !important;
max-width: 100% !important;
margin: 0 auto !important;
padding: 1rem !important;
}
/* On mobile keep the community TOC below the content */
body.section-community .docs-toc {
flex: 0 0 100% !important;
max-width: 100% !important;
margin: 1rem 0 !important;
padding: 0 !important;
}
}
7 changes: 6 additions & 1 deletion config/_default/menus/menus.en.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,12 @@

[[main]]
name = "Community"
url = "/docs/community/community"
url = "/community/community"
weight = 20

[[main]]
name = "Roadmap"
url = "/roadmap/roadmap"
weight = 30

[[social]]
Expand Down
6 changes: 3 additions & 3 deletions config/_default/params.toml
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ mainSections = ["docs"]
# Doks (@thulite/doks-core)
[doks]
# Color mode
# For now, all PNG text is White so switching to Light mode will make those texts disappear.
colorMode = "dark" # auto (default), light or dark
colorModeToggler = false # true (default) or false (this setting is only relevant when colorMode = auto)
# For now, all PNG text is White so switching to Light mode will make those texts disappear
colorMode = "dark" # Use "auto", "light", or "dark"
colorModeToggler = false # Enables the color mode toggle button

# Navbar
navbarSticky = true # true (default) or false
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title : "Community"
layout: community
description: "Community"
weight: 90
lead: ""
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "The OCM Community"
description: "The OCM Community"
url: /docs/community/community
url: community/community
lead: true
draft: false
images: []
Expand Down
2 changes: 1 addition & 1 deletion content/docs/cli-reference/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: cli-reference
title: CLI-Reference
name: cli-reference
url: /docs/cli-reference/
draft: false
Expand Down
9 changes: 0 additions & 9 deletions content/docs/component-descriptors/_index.md

This file was deleted.

1 change: 0 additions & 1 deletion content/docs/controller/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title : "OCM Controllers"
description: ""
weight: 40
lead: ""
draft: false
images: []
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Architecture"
description: "OCM Controller Architecture"
draft: false
images: []
weight: 41
weight: 42
toc: true
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: ""
lead: ""
draft: false
images: []
weight: 55
weight: 44
toc: true
---

Expand Down
11 changes: 0 additions & 11 deletions content/docs/controller/controller-reference/_index.md

This file was deleted.

This file was deleted.

This file was deleted.

Loading