Skip to content

Commit

Permalink
Improve Status and Training page layout, some copyedits (#6296)
Browse files Browse the repository at this point in the history
  • Loading branch information
chalin authored Feb 12, 2025
1 parent f15873c commit 1f83b9f
Show file tree
Hide file tree
Showing 5 changed files with 87 additions and 19 deletions.
2 changes: 1 addition & 1 deletion .htmltest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ IgnoreDirs:
IgnoreInternalURLs: # list of paths
IgnoreURLs: # list of regexs of paths or URLs to be ignored
- /index.xml$ # Ignore rel="alternative" links to RSS feeds
- ^/api$
- ^/api/?$
- ^((/..)?/docs/languages/\w+|\.\.)/(api|examples|registry)/$
- ^(/..)?/docs/collector/registry/$
- ^(/..)?/docs/languages/net/(metrics-api|traces-api)/
Expand Down
53 changes: 53 additions & 0 deletions assets/scss/_page_no_left_sidebar.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
// Styles for docs-like pages without left sidebar

.td-no-left-sidebar .td-main {
// Hide left sidebar
.td-sidebar {
display: none !important;
}

// Adjust ToC sidebar, e.g., to fill Bootstrap columns that the left sidebar
// would have taken was using.
.td-sidebar-toc {
@include media-breakpoint-up(md) {
display: block !important;
}

// Always 2 col wide (unless hidden)
@extend .col-md-2;

// Don't scroll with the page (otherwise, for short pages, the ToC hides
// behind the top navbar).
position: fixed;
right: 0;

// Ensure ToC doesn't overlap with the footer
z-index: -1;
}

// The <main> element sibling of the ToC sidebar
> div > main {
// Always 10 col wide (unless the ToC sidebar is hidden)
@extend .col-md-10;
@extend .col-xl-10;

@include media-breakpoint-up(md) {
padding-right: 3rem;
}

@include media-breakpoint-up(lg) {
// Center content on larger screens

.td-content {
max-width: 80%;
margin-left: auto;
margin-right: auto;

// Cancel .td-max-width-on-larger-screens
> * {
max-width: 100%;
}
}
}
}
}
21 changes: 20 additions & 1 deletion assets/scss/_styles_project.scss
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
/* Docsy-delta full file override: we're not tracking changes to the Docsy file of the same name. */
// cSpell:ignore cncf docsy
// cSpell:ignore cncf docsy otca

@import 'registry';
@import 'tabs';
@import 'external_link';
@import 'td/code-dark';
@import '_page_no_left_sidebar';

.td-home {
.otel-logo {
Expand Down Expand Up @@ -335,3 +336,21 @@ details {
padding-left: 0.6rem;
}
}

.ot-training {
@extend .td-no-left-sidebar;

.otca img {
border-style: none !important;
max-width: 244px;
margin: auto;
}
}

// TODO: upstream to Docsy

.hk-no-external-icon {
a.external-link:after {
display: none !important;
}
}
8 changes: 2 additions & 6 deletions content/en/status.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,10 @@ title: Status
menu: { main: { weight: 30 } }
aliases: [/project-status, /releases]
description: Maturity-level of the main OpenTelemetry components
type: docs
body_class: td-no-left-sidebar
---

{{% blocks/section color="white" %}}

## {{% param title %}}

OpenTelemetry is made up of [several components](/docs/concepts/components/),
some language-specific and others language-agnostic. When looking for a
[status](/docs/specs/otel/versioning-and-stability/), make sure to look for the
Expand Down Expand Up @@ -50,5 +48,3 @@ state with components in `v1alpha1` and `v1beta1` states.
For the development status, or maturity level, of the
[specification](/docs/specs/otel/), see the following:
[Specification Status Summary](/docs/specs/status/).

{{% /blocks/section %}}
22 changes: 11 additions & 11 deletions content/en/training/_index.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
---
title: Training
menu: { main: { weight: 45 } }
description: Training programs and certifications for OpenTelemetry
description: OpenTelemetry certifications and courses
type: docs
body_class: ot-training
hide_feedback: true
cSpell:ignore: otca
---

{{% blocks/section color="white" %}}

## {{% param title %}}

This page showcases training resources for the OpenTelemetry project. Check back
often for updates!

Expand All @@ -17,12 +16,13 @@ often for updates!
Demonstrate your expertise in OpenTelemetry by becoming an OpenTelemetry
Certified Associate.

<a href="https://www.cncf.io/training/certification/otca/">
<img src="lft-badge-opentelemetry-associate2.svg" style="width: 250px; height: auto;" alt="OTCA Badge">
</a>
<!-- prettier-ignore -->
[![OTCA badge]][OTCA URL]
{.otca .hk-no-external-icon}

### Training programs
[OTCA badge]: lft-badge-opentelemetry-associate2.svg
[OTCA URL]: https://www.cncf.io/training/certification/otca/

Coming soon!
### Courses

{{% /blocks/section %}}
Coming soon!

0 comments on commit 1f83b9f

Please sign in to comment.