Skip to content

Commit

Permalink
Merge branch 'main' into style-guide
Browse files Browse the repository at this point in the history
  • Loading branch information
didiViking authored Feb 13, 2025
2 parents 8d0322f + 0dac041 commit b368b9c
Show file tree
Hide file tree
Showing 14 changed files with 141 additions and 41 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;
}
}
11 changes: 11 additions & 0 deletions content/en/docs/collector/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,17 @@ example:
otelcol --config=customconfig.yaml
```

You can also provide multiple configurations using multiple files at different
paths. Each file can be a full or partial configuration, and the files can
reference components from each other. If the merger of files does not constitute
a complete configuration, the user receives an error since required components
are not added by default. Pass in multiple file paths at the command line as
follows:

```shell
otelcol --config=file:/path/to/first/file --config=file:/path/to/second/file
```

You can also provide configurations using environment variables, HTTP URIs, or
YAML paths. For example:

Expand Down
48 changes: 31 additions & 17 deletions content/en/docs/contributing/issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,33 +9,47 @@ _issue: https://github.com/open-telemetry/opentelemetry.io/issues?q=is%3Aissue+i
cSpell:ignore: prepopulated
---

<style>
/* Force all list to be compact. */
li > p {
margin-bottom: 0;
}

/* Style "first time" alert */
.alert--first-timer {
margin: 0.5rem 0 !important;

> blockquote {
margin-top: 1rem;
margin-bottom: 0;
border-left-color: var(--bs-warning);
background-color: var(--bs-danger-bg-subtle);
> *:last-child {
margin-bottom: 0;
}
}
}
</style>

## Fixing an existing issue

One of the best ways to help make OTel docs better is to fix an existing issue.

1. Browse through the list of [issues]({{% param _issues %}}).
2. Select an issue that you would like to work on, ideally one that you can fix
in a short amount of time.

<!-- prettier-ignore -->
<a name="first-issue"></a>
{{% alert title="First time contributing? " %}}
in a short amount of time. <a name="first-issue"></a>
{{% alert title="First time contributing?" color="primary alert--first-timer" %}}

Select an issue with the following labels:

- [Good first issue]
- [Help wanted]

<!-- prettier-ignore -->
> **NOTE**: we **_do not_ assign issues** to those who
> have not already made contributions to the [OpenTelemetry
> organization][org], unless part of a mentorship or onboarding
> process.
{.mt-3}
- [Good first issue](<{{% param _issue %}}%22good+first+issue%22>)
- [Help wanted](<{{% param _issue %}}%3A%22help+wanted%22>)

[good first issue]: <{{% param _issue %}}%22good+first+issue%22>
[help wanted]: <{{% param _issue %}}%3A%22help+wanted%22>
[org]: https://github.com/open-telemetry
> **NOTE**: we **_do not_ assign issues** to those who have not already made
> contributions to the [OpenTelemetry organization][org], unless part of a
> mentorship or onboarding process.
>
> [org]: https://github.com/open-telemetry
{{% /alert %}}

Expand Down
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!
3 changes: 3 additions & 0 deletions data/community/members.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2371,6 +2371,9 @@ members:
- name: RichiH
html_url: https://github.com/RichiH
avatar_url: https://avatars.githubusercontent.com/u/754723?v=4
- name: rlankfo
html_url: https://github.com/rlankfo
avatar_url: https://avatars.githubusercontent.com/u/364801?v=4
- name: rochdev
html_url: https://github.com/rochdev
avatar_url: https://avatars.githubusercontent.com/u/1596303?v=4
Expand Down
2 changes: 1 addition & 1 deletion data/registry/exporter-dotnet-onecollector.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ createdAt: 2023-03-03
package:
registry: nuget
name: OpenTelemetry.Exporter.OneCollector
version: 1.11.0-beta.1
version: 1.11.0
2 changes: 1 addition & 1 deletion data/registry/instrumentation-js-azure-sdk.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,6 @@ urls:
package:
name: '@azure/opentelemetry-instrumentation-azure-sdk'
registry: npm
version: 1.0.0-beta.7
version: 1.0.0-beta.8
createdAt: 2021-12-16
isFirstParty: true
2 changes: 1 addition & 1 deletion data/registry/instrumentation-php-pdo.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,5 @@ createdAt: 2023-05-22
package:
registry: packagist
name: open-telemetry/opentelemetry-auto-pdo
version: 0.0.16
version: 0.0.17
isFirstParty: false
2 changes: 1 addition & 1 deletion data/registry/instrumentation-ruby-all.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@ createdAt: 2020-11-09
package:
registry: gems
name: opentelemetry-instrumentation-all
version: 0.73.1
version: 0.74.0
isFirstParty: false
2 changes: 1 addition & 1 deletion data/registry/instrumentation-ruby-rdkafka.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,5 @@ createdAt: 2022-10-27
package:
registry: gems
name: opentelemetry-instrumentation-rdkafka
version: 0.5.0
version: 0.6.0
isFirstParty: false
4 changes: 4 additions & 0 deletions static/refcache.json
Original file line number Diff line number Diff line change
Expand Up @@ -11775,6 +11775,10 @@
"StatusCode": 206,
"LastSeen": "2025-01-07T10:32:29.804441-05:00"
},
"https://github.com/rlankfo": {
"StatusCode": 206,
"LastSeen": "2025-02-12T18:44:21.763542368Z"
},
"https://github.com/roadrunner-server": {
"StatusCode": 206,
"LastSeen": "2025-02-02T10:24:50.464456-05:00"
Expand Down

0 comments on commit b368b9c

Please sign in to comment.