diff --git a/content/_index.md b/content/_index.md new file mode 100644 index 000000000..2e2e802a2 --- /dev/null +++ b/content/_index.md @@ -0,0 +1,11 @@ +--- +title: "Crossplane Documentation" +weight: 13 +--- + +{{< img src="/media/banner.png" alt="Crossplane Popsicle Truck" size="large" >}} + +
+ +Crossplane is an open source Kubernetes extension that transforms your Kubernetes +cluster into a **universal control plane**. diff --git a/content/cli/_index.md b/content/cli/_index.md new file mode 100644 index 000000000..b0647fe6b --- /dev/null +++ b/content/cli/_index.md @@ -0,0 +1,13 @@ +--- +weight: 40 +title: Crossplane CLI +description: "Documentation for the Crossplane command-line interface" +--- + +The Crossplane CLI helps simplify some development and administration aspects of +Crossplane. + +The Crossplane CLI includes: +* tools to build, install, update and push Crossplane Packages +* standalone Composition Function testing and rendering without the need to access a Kubernetes cluster running Crossplane +* visual dependency mapping across Compositions, Composite Resources and Managed Resources diff --git a/content/cli/command-reference.md b/content/cli/command-reference.md new file mode 100644 index 000000000..703ac64b2 --- /dev/null +++ b/content/cli/command-reference.md @@ -0,0 +1,8 @@ +--- +weight: 50 +title: Command Reference +description: "Command reference for the Crossplane CLI" +--- + + +The `crossplane` CLI provides utilities to make using Crossplane easier. diff --git a/content/getting-started/_index.md b/content/getting-started/_index.md index b629ff839..c3d9bfd91 100644 --- a/content/getting-started/_index.md +++ b/content/getting-started/_index.md @@ -1,5 +1,5 @@ --- -title: Getting Started +title: Get Started weight: 1 description: An introduction to Crossplane and Crossplane quickstart guides. --- diff --git a/content/master/_index.md b/content/master/_index.md index 8dee72808..0f94cdf16 100644 --- a/content/master/_index.md +++ b/content/master/_index.md @@ -3,6 +3,7 @@ title: "Overview" weight: 10 cascade: version: "master" + draft: true --- {{< img src="/media/banner.png" alt="Crossplane Popsicle Truck" size="large" >}} diff --git a/content/v1.11/_index.md b/content/v1.11/_index.md index 37ac20246..731b0052b 100644 --- a/content/v1.11/_index.md +++ b/content/v1.11/_index.md @@ -1,6 +1,6 @@ --- -title: "Overview" -weight: 11 +title: "Crossplane v1.11" +weight: 12 cascade: version: "1.11" --- diff --git a/content/v1.12/_index.md b/content/v1.12/_index.md index d2f1fb266..78e223ea4 100644 --- a/content/v1.12/_index.md +++ b/content/v1.12/_index.md @@ -1,6 +1,6 @@ --- -title: "Overview" -weight: 12 +title: "Crossplane v1.12" +weight: 11 cascade: version: "1.12" --- diff --git a/content/v1.13/_index.md b/content/v1.13/_index.md index bb646f073..549ede3fe 100644 --- a/content/v1.13/_index.md +++ b/content/v1.13/_index.md @@ -1,6 +1,6 @@ --- -title: "Overview" -weight: 13 +title: "Crossplane v1.13" +weight: 10 cascade: version: "1.13" --- diff --git a/themes/geekboot/assets/scss/_sidebar.scss b/themes/geekboot/assets/scss/_sidebar.scss index 143434e15..57e666567 100644 --- a/themes/geekboot/assets/scss/_sidebar.scss +++ b/themes/geekboot/assets/scss/_sidebar.scss @@ -83,4 +83,161 @@ } } } +} + +// Styling related to the left-side global navigation + +// Custom modifications to built-in bootstrap tooling for the left-hand-nav/a +#left-nav-menu { + overflow-y: scroll; + height: auto; + position: sticky; + top: 40px; + max-height: 100vh; + padding-bottom: 60px; + +} + +.left-sidebar-nav{ + grid-area: left-sidebar-nav; + + flex-grow: 1 !important; + + @include media-breakpoint-down(xl) { + margin-top: 65px; + } + + &.offcanvas-xl { + background: #FFFFFF !important; + } + + .left-offset { + min-width: 28px; + } +} + +// search results display clones of the left side-nav content +// the styles below will apply to both the side-nav and the search results + +$nav-section-lr-padding: 12px; +$nested-offset: 12px; +$font-size: 14px; + +#search-results, #left-nav-menu { + .list-group { + + // Remove unwanted default list-group stylings + --bs-list-group-border-radius: 0; + --bs-list-group-item-padding-x: 0; + --bs-list-group-border-width: 0; + + // Default nav item state + --bs-list-group-action-hover-bg: #F2F2F4; + + // Clicked on nav menu item + --bs-list-group-action-active-color: #{$aqua-400}; + --bs-list-group-action-active-bg: #{$aqua-100}; + + // Active nav menu item + --bs-list-group-active-color: #{$aqua-400}; + --bs-list-group-active-bg: #{$aqua-100}; + --bs-accordion-border-radius: 4; + + --bs-list-group-item-padding-y: 10px; + + // The expand/collapse nav button uses the bootstrap accordion components + .accordion { + --bs-accordion-bg: transparent; + --bs-accordion-active-bg: transparent; + --bs-accordion-btn-padding-y: 10px; + --bs-accordion-btn-padding-x: 2px; + --bs-accordion-border-color: transparent; + --bs-accordion-border-width: 0; + + &::after { + background-image: url('data:image/svg+xml,<%3Fxml version="1.0" encoding="UTF-8"%3F>Chevron-Down'); + } + + } + + .accordion-button{ + --bs-accordion-btn-icon-width: 16px; + // size of the grey box containing the chevron + width: 22px; + height: 22px; + border: none; + + &:after{ + margin-left: 1px; + } + } + + &.top-level { + padding: 32px 28px 0px; + } + } + + .nav-parent-container{ + font-weight: 800; + font-size: .9rem; + align-items: center; + border-radius: 8px; + padding: 8px $nav-section-lr-padding; + + &:not(.disabled):hover{ + background-color: #{$fog-50}; + cursor: pointer; + } + + &.disabled { + pointer-events: none; + } + + .nav-parent-title { + font-size: $font-size; + } + } + + .nav-child-container { + .nav-child{ + align-items: center; + border-radius: 8px; + padding-left: calc(#{$nav-section-lr-padding} + #{$nested-offset}); + padding-right: $nav-section-lr-padding; + + &.active { + font-weight: 600; + } + } + + .subpages .nav-child { + padding-left: calc(#{$nav-section-lr-padding} + (#{$nested-offset * 2})); + padding-right: $nav-section-lr-padding; + } + } + + a { + text-decoration: none; + color: inherit; + font-size: $font-size; + } + + .subheader { + cursor: pointer; + + .subheader-title { + font-size: $font-size; + color: var(--body-font-color); + } + } + + .button-container{ + padding-left: 0px; + } + + .left-offset { + &.hide { + opacity: 0; + } + } } \ No newline at end of file diff --git a/themes/geekboot/layouts/_default/home.html b/themes/geekboot/layouts/_default/home.html deleted file mode 100644 index c451e1852..000000000 --- a/themes/geekboot/layouts/_default/home.html +++ /dev/null @@ -1,54 +0,0 @@ -{{ define "main" }} - -{{/* Define the section cards on the landing page. */}} -{{/* Cards are displayed in order */}} -{{ $sectionSlice := slice - (dict "User Documentation" "/img/automate.svg") - (dict "Knowledge Base" "/img/truck.svg") - (dict "Contributing Guide" "/img/multi-crane.svg") -}} - - -
-
- {{ partialCached "search-button" . }} -
-
- - -
-
- - {{ $thisSite := .Site }} - {{ $version_section := slice }} - {{ range $sectionSlice }} - {{ range $docType, $headerImage := . }} - {{ if eq $docType "User Documentation" }} - {{ $version_section = where $thisSite.Sections ".Page.Params.version" $thisSite.Params.latest }} - {{ else }} - {{ $version_section = where $thisSite.Sections ".Page.Params.product" $docType }} - {{ end }} -
- ... -
-

{{range $version_section }}{{$docType}} {{ end }}

-
    - {{ range ((index $version_section 0).Pages).GroupBy "Weight" }} - {{ range .Pages.ByWeight }} - {{ if not .Params.tocHidden }} -
  • - {{ .Title }}
    - {{ .Description }} -
    • - {{ end }} - {{ end }} - {{ end }} -
-
-
- {{ end }} - {{ end }} -
-
-{{ end }} - diff --git a/themes/geekboot/layouts/partials/docs-sidebar.html b/themes/geekboot/layouts/partials/docs-sidebar.html index 7e98f070d..eedb98ffb 100644 --- a/themes/geekboot/layouts/partials/docs-sidebar.html +++ b/themes/geekboot/layouts/partials/docs-sidebar.html @@ -1,53 +1,100 @@ -{{ $current := . }} - \ No newline at end of file + + \ No newline at end of file diff --git a/themes/geekboot/layouts/partials/single-list.html b/themes/geekboot/layouts/partials/single-list.html index ce7b3122a..6f22fc029 100644 --- a/themes/geekboot/layouts/partials/single-list.html +++ b/themes/geekboot/layouts/partials/single-list.html @@ -19,9 +19,6 @@
- {{ if $.Param "docs" }} - {{ partial "version-dropdown-menu" . }} - {{ end }}

{{ .Title | markdownify }}

diff --git a/themes/geekboot/layouts/partials/version-dropdown-menu.html b/themes/geekboot/layouts/partials/version-dropdown-menu.html deleted file mode 100644 index 0653649b7..000000000 --- a/themes/geekboot/layouts/partials/version-dropdown-menu.html +++ /dev/null @@ -1,74 +0,0 @@ -{{ $versionList := slice }} -{{ $majordict := dict }} -{{ $majorlist := slice }} -{{ $sorted_list := slice }} -{{ $cur_ver := .Page.Params.version | default .Site.Params.latest }} - - -{{ range .Site.Sections }} - {{ if eq .Page.Params.version "master" }} - {{$sorted_list = $sorted_list | append "master" }} - {{ else if ne .Page.Params.version nil }} - {{ $splitver := split .Page.Params.version "." }} - {{ if eq (len $splitver) 2 }} - {{ $verlist := (index $majordict (index $splitver 0)) }} - {{ $verlist = $verlist | append (index $splitver 1) }} - {{ $majordict = merge $majordict (dict (index $splitver 0) $verlist) }} - {{ $majorlist = $majorlist | append (index $splitver 0) }} - {{ end }} - {{ end }} -{{ end }} - -{{ range sort ($majorlist | uniq) "value" "desc" }} - {{ $majorver := . }} - {{ range sort (index $majordict .) "value" "desc" }} - {{$sorted_list = $sorted_list | append (printf "%s.%s" $majorver .) }} - {{ end }} -{{ end }} - -
- - -
- {{ $master_url := replaceRE "v[0-9].[0-9]" "master" .Permalink }} - {{/* Iterate over the ordered list of available versions. */}} - {{ range $sorted_list }} - {{ $matchingTitle := $.Title }} - {{ if $.Params.matchTitle }} - {{ $matchingTitle = $.Params.matchTitle }} - {{ end }} - {{/* For a version, see if there is a page with an identical title to the page we're on. If not use the page at /content/v */}} - {{ $versionPage := index (where (where $.Site.Pages "Title" $matchingTitle) ".Page.Params.version" .) 0 | default ($.Site.GetPage (printf "v%s" .)) }} - {{/* If the version is master get the master page since "vmaster" doesn't exist */}} - {{ if not $versionPage }} - {{ $versionPage = $.Site.GetPage "master" }} - {{ end }} - {{ with $versionPage }} - {{ $isLatest := false }} - {{ if or (eq .Page.Params.version "") (eq .Page.Params.version $cur_ver) }} - {{ $isLatest = true }} - {{ end }} - - {{ if eq .Page.Params.version "master" }} - master - {{ else }} - {{ if eq .Page.Params.version "" }} - {{ (printf "v%s" .Site.Params.latest) }} - {{ else }} - {{ (printf "v%s" .Page.Params.version) }} - {{ end }} - {{ end }} - {{ if or (eq .Page.Params.version .Site.Params.latest) (eq .Page.Params.version "") }} -
Latest
- {{ end }} - - {{ end }} - {{ end }} -
-
-