Merge branch 'main' into style-guide

Author: didiViking

.github/workflows/check-file.yml

@@ -0,0 +1,28 @@
+name: Files
+
+on:
+  merge_group:
+  pull_request:
+
+jobs:
+  check-expired:
+    name: EXPIRED FILE check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: npm run check:expired
+      - run: npm run _diff:fail
+
+  check-filenames:
+    name: FILENAME check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: npm run check:filenames
+
+  check-formatting:
+    name: FILE FORMAT
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: npm run check:format

.github/workflows/check-format.yml

@@ -26,16 +26,19 @@ jobs:
           suggestions: true
 
   dict-check:
-    name: CSPELL:IGNORE check
+    name: CSPELL page-local word list check
     runs-on: ubuntu-latest
+    env:
+      FIX_CMD: fix:dict
     steps:
       - uses: actions/checkout@v4
-      - run: npm run fix:dict
+      - run: npm run ${{ env.FIX_CMD }}
       - name: Any changed files?
         run: |
           CHANGES=`git status --porcelain`
           if [[ $CHANGES ]]; then
-            echo "Locally run `npm run fix:dict` and commit the changes:"
+            echo "Add comment '/fix:${{ env.FIX_CMD }}' to your PR in GitHub,"
+            echo "or locally run 'npm run ${{ env.FIX_CMD }}' and commit the changes:"
             echo "$CHANGES"
             exit 1
           else

.github/workflows/check-spelling.yml

@@ -2,7 +2,7 @@
 [submodule "themes/docsy"]
 	path = themes/docsy
 	url = https://github.com/google/docsy.git
-	docsy-pin = v0.11.0-38-g77da7e49
+	docsy-pin = v0.11.0-39-g9e685592
 	docsy-note = "2024-04-01 Switching to google/docsy.git from cncf/docsy.git since we don't have any CNCF customizations."
 	docsy-reminder = "Ensure that any tag referenced by `docsy-pin` is present in the remote repo (url), otherwise add (push) the tags to the repo."
 [submodule "content-modules/opentelemetry-specification"]

.gitmodules

@@ -55,21 +55,28 @@ IgnoreURLs: # list of regexs of paths or URLs to be ignored
   # Ignore Docsy-generated GitHub links for now, until
   # https://github.com/google/docsy/issues/1432 is fixed
   - ^https?://github\.com/.*?/.*?/(new|edit|issues/new\?title)/ # view-page, edit-source etc
-  # Here's an approximate regex to avoid the "View page source" links. TODO: fix this in Docsy
-  - ^https?://github\.com/open-telemetry/opentelemetry.io/tree/
-  # FIXME: A patch until we can get Docsy to mark "View page source" links as excluded from link checking,
-  # Actually, it would be better to pin the version of the OTel spec.
-  - ^https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/logs/event-(api|sdk)\.md
+  # Ignore "View page source" links, except for spec pages, i.e., links starting with
+  # https://github.com/open-telemetry/opentelemetry.io/tree/main/content/en/docs/specs
+  - ^https://github\.com/open-telemetry/opentelemetry.io/tree/main/content/[^e]
+  - ^https://github\.com/open-telemetry/opentelemetry.io/tree/main/content/es
+  - ^https://github\.com/open-telemetry/opentelemetry.io/tree/main/content/en/.*?/_index.md$
+  - ^https://github\.com/open-telemetry/opentelemetry.io/tree/main/content/en/[^d]
+  - ^https://github\.com/open-telemetry/opentelemetry.io/tree/main/content/en/docs/[^s]
+  - ^https://github\.com/open-telemetry/opentelemetry.io/tree/main/content/en/docs/security
   # FIXME: same issue as for the OTel spec mentioned above:
   - ^https://github.com/open-telemetry/semantic-conventions/tree/main
 
   # Too many redirects as the server tries to figure out the country and language,
   # e.g.: https://www.microsoft.com/en-ca/sql-server.
   - ^https://www.microsoft.com/sql-server$
 
-  # TODO: drop after fix to https://github.com/rust-lang/crates.io/issues/788
-  - ^https://crates\.io/crates
   # TODO move into content/en/blog/2023/humans-of-otel.md once https://github.com/open-telemetry/opentelemetry.io/issues/3889 is implemented
   - ^https://shorturl.at/osHRX$
   # TODO move into content/en/blog/2023/contributing-to-otel/index.md once https://github.com/open-telemetry/opentelemetry.io/issues/3889 is implemented
   - ^https://shorturl.at/vLYZ0$
+
+  # Temporary until semconv is updated to 1.30.0+
+  - ^https://cloud.google.com/apis/design/resource_names#full_resource_name
+  - ^https://cloud.google.com/functions/docs/concepts/exec#function_scope_versus_global_scope
+  - ^https://developer.apple.com/documentation/uikit/uiapplicationdelegate#1656902
+  - ^https://docs.docker.com/registry/spec/manifest-v2-2/#example-image-manifest

.htmltest.yml

@@ -113,10 +113,11 @@ rules:
       # https://github.com/sapegin/textlint-rule-terminology/blob/ca36a645c56d21f27cb9d902b5fb9584030c59e3/index.js#L137-L142.
       #
       - ['3rd[- ]party', third-party]
-      - ['auto[- ]c(onfigur)(es?|ations?)', 'autoc$1$2'] # cspell:ignore autoc ations onfigur
+      - ['auto[- ]c(onfigur)(es?|ations?)', 'autoc$1$2'] # cSpell:disable-line
       - ['back[- ]end(s)?', 'backend$1']
       - [bugfix, bug fix]
       - [byte code, bytecode]
+      - ['(cloud)-(native)', '$1 $2']
       - [cpp, C++]
       - # dotnet|.net -> .NET, but NOT for strings like:
         # - File extension: file.net

.textlintrc.yml

@@ -2,4 +2,6 @@
 title: Announcements
 cascade:
   type: docs
+  params:
+    hide_feedback: true
 ---

content/en/announcements/_index.md

@@ -0,0 +1,14 @@
+---
+title: KubeCon + CloudNativeCon Europe 2025
+linkTitle: KubeCon EU 2025
+date: 2025-02-03
+expiryDate: 2025-04-04
+---
+
+<i class="fas fa-bullhorn"></i> [**{{% param title %}}**][LF],
+**<span class="text-nowrap">April 1 - 4,</span> London England**.
+<span class="d-none d-md-inline"><br></span> Come collaborate, learn, and
+share<span class="d-none d-sm-inline"> with the Cloud Native community</span>!
+
+[LF]:
+  https://events.linuxfoundation.org/kubecon-cloudnativecon-europe/register/?utm_source=opentelemetry&utm_medium=all&utm_campaign=KubeCon-EU-2025&utm_content=slim-banner

content/en/announcements/devex-survey.md

@@ -17,7 +17,7 @@ community by establishing processes. Let me explain.
 ![Watering can](watering-can.jpeg)
 
 The main objective of the OpenTelemetry project is to make robust, portable
-telemetry a built-in feature of cloud-native software. The most effective way to
+telemetry a built-in feature of cloud native software. The most effective way to
 do it is to build a community of passionate people, from existing ecosystem with
 the diverse expertise and experience. This community will build a project that
 is attractive to users, who will use it to instrument their software, as well as

content/en/announcements/kubecon-eu.md

@@ -126,7 +126,7 @@ ourselves to just the items listed here.
 - Demonstrations of the ability to add
   [Baggage](https://github.com/open-telemetry/opentelemetry-demo/issues/100) and
   other custom tags
-- Continue to build on other cloud-native technologies like:
+- Continue to build on other cloud native technologies like:
   - Kubernetes
   - gRPC
   - [OpenFeature](https://github.com/open-feature)

content/en/blog/2019/opentelemetry-governance-committee-explained/index.md

@@ -11,7 +11,7 @@ system in a distributed environment. Different services communicate with each
 other by using Apache Kafka as a messaging system but even more as en event or
 data streaming platform.
 
-Taking into account the cloud-native approach for developing microservices,
+Taking into account the cloud native approach for developing microservices,
 quite often [Kubernetes](https://kubernetes.io/) is also used to run the
 workloads. In this scenario, you can also easily deploy and manage an Apache
 Kafka cluster on top of it, by using a project like

content/en/blog/2022/demo-announcement/index.md

@@ -9,7 +9,7 @@ cSpell:ignore: k8sattributes k8sattributesprocessor k8sprocessor KUBE replicaset
 
 {{% alert title="Note" color="info" %}} The most up to date information for how
 to enhance telemetry with Kubernetes metadata can be found in the docs. See
-[Getting Started with Kubernetes](/docs/kubernetes/getting-started/) for more
+[Getting Started with Kubernetes](/docs/platforms/kubernetes/getting-started/) for more
 info. {{% /alert %}}
 
 Attaching Kubernetes resource metadata to OpenTelemetry traces is useful to

content/en/blog/2022/instrument-kafka-clients/index.md

@@ -106,7 +106,7 @@ in this setup are mentioned in brackets.
   [v1.2.1] installed.
 - A Kubernetes [v1.23.3] edge cluster to create a test cluster. Using
   [Kind](https://kind.sigs.k8s.io/) is recommended.
-- Installed [OpenTelemetry Operator](/docs/kubernetes/operator/) [v0.58.0] on
+- Installed [OpenTelemetry Operator](/docs/platforms/kubernetes/operator/) [v0.58.0] on
   both ends.
 - Installed [Jaeger Operator](https://www.jaegertracing.io/docs/1.37/operator/)
   [v1.37.0] on your public cluster.

content/en/blog/2022/k8s-metadata/index.md

@@ -22,7 +22,7 @@ experience. The Observability landscape is an ever-changing one and recent
 developments in the OpenTelemetry world forced us to rethink our strategy in
 order to pivot to using it. eBay’s observability platform Sherlock.io provides
 developers and Site Reliability Engineers (SREs) with a robust set of
-cloud-native offerings to observe the various applications that power the eBay
+cloud native offerings to observe the various applications that power the eBay
 ecosystem. Sherlock.io supports the three pillars of observability — metrics,
 logs and traces. The platform’s metric store is a clustered and sharded
 implementation of the Prometheus storage engine. We use the Metricbeat agent to

content/en/blog/2022/k8s-otel-expose/index.md

@@ -145,7 +145,7 @@ Feeling a little more adventurous? Then why not join one of the other OTel
 (SIGs)? By joining a SIG, you can contribute to things like (but not limited to)
 SDK development, auto-instrumentation of libraries, the
 [OTel Collector](/docs/collector/), and the
-[OTel Operator](/docs/kubernetes/operator/). You don't even need to be a regular
+[OTel Operator](/docs/platforms/kubernetes/operator/). You don't even need to be a regular
 contributor. Sometimes, contributions come out of necessity. Like maybe you
 found a bug in the Collector. Why not take a stab at fixing it? Or maybe there's
 a feature that you and your team desperately need. Again, why not take a stab at

content/en/blog/2022/why-and-how-ebay-pivoted-to-opentelemetry/index.md

@@ -69,7 +69,7 @@ at the chance to work with it.
 ### What is the architecture at Farfetch like? How has OpenTelemetry helped?
 
 Farfetch currently has 2000 engineers, with a complex and varied architecture
-which includes cloud-native, Kubernetes, and virtual machines running on three
+which includes cloud native, Kubernetes, and virtual machines running on three
 different cloud providers. There is a lot of information coming from everywhere,
 with a lack of standardization on how to collect this information. For example,
 Prometheus is used mostly as a standard for collecting metrics; however, in some
@@ -156,9 +156,9 @@ others are still instrumented using the [legacy OpenTracing
 [using shims](/docs/migration/opentracing/).
 
 The OpenTelemetry Operator is being implemented to auto-instrument Java and .NET
-code. Among other things, the [OTel Operator](/docs/kubernetes/operator/)
+code. Among other things, the [OTel Operator](/docs/platforms/kubernetes/operator/)
 supports injecting and
-[configuring auto-instrumentation](/docs/kubernetes/operator/automatic/#configure-automatic-instrumentation)
+[configuring auto-instrumentation](/docs/platforms/kubernetes/operator/automatic/#configure-automatic-instrumentation)
 in .NET, Java, Python, and Node.js. Iris hopes that Go auto-instrumentation will
 be available in the near-future. To track progress of auto-instrumentation in
 Go, see
@@ -255,7 +255,7 @@ would be a bottleneck in terms of load and single point of failure. The team
 currently has one
 [OpenTelemetry Collector agent](/docs/collector/deployment/agent/) per
 Kubernetes cluster. The end goal is to replace those agents with the
-[OTel Operator](/docs/kubernetes/operator/) instead, which allows you to deploy
+[OTel Operator](/docs/platforms/kubernetes/operator/) instead, which allows you to deploy
 and configure the OTel Collector and inject and configure auto-instrumentation.
 
 Everything is then sent to a central OTel Collector (i.e. an

content/en/blog/2023/contributing-to-otel/index.md

@@ -111,9 +111,9 @@ that our Kafka installation is working as expected.
 ### Export metrics to Prometheus
 
 The metrics can be exported by any of the supported metric exporters, to a
-backend of your choice. The full list of exporters and their configuration
-options can be found
-[here](https://github.com/open-telemetry/opentelemetry-java/blob/main/sdk-extensions/autoconfigure/README.md#exporters).
+backend of your choice. For the full list of exporters and their configuration
+options, see
+[Properties: exporters](/docs/languages/java/configuration/#properties-exporters).
 For instance, you can export the metrics to an OTel collector using the OTLP
 exporter, perform some processing and then consume the metrics on a backend of
 your choice. In this example for the sake of simplicity, we are directly

content/en/blog/2023/end-user-q-and-a-03.md

@@ -42,7 +42,7 @@ Come network with OpenTelemetry maintainers and core contributors during the
 2023 from 16:00 - 17:00. You can attend with a _standard in-person pass_.
 
 [Observability Day][] _fosters collaboration, discussion, and knowledge sharing
-of cloud-native observability projects_. This event will be held on April 18,
+of cloud native observability projects_. This event will be held on April 18,
 2023 from 9:00 - 17:00. There will be several sessions on OpenTelemetry as well.
 
 > <i class="far fa-exclamation-triangle"></i> **IMPORTANT access note**: You

content/en/blog/2023/jmx-metric-insight/index.md

@@ -79,7 +79,7 @@ OpenTelemetry maintainers in making OpenTelemetry better for everyone during the
 ## Co-located Events
 
 [Observability Day][] _fosters collaboration, discussion, and knowledge sharing
-of cloud-native observability projects_. This event will be held on November 6,
+of cloud native observability projects_. This event will be held on November 6,
 2023 from 9am - 5pm. There will be several sessions on OpenTelemetry as well.
 
 > <i class="far fa-exclamation-triangle"></i> **IMPORTANT access note**: You

content/en/blog/2023/kubecon-eu.md

@@ -9,7 +9,7 @@ cSpell:ignore: adot otel-faas socha
 The
 [Functions-as-a-Service (FaaS) SIG](https://docs.google.com/document/d/187XYoQcXQ9JxS_5v2wvZ0NEysaJ02xoOYNXj08pT0zc)
 is incredibly excited to announce that the release of OpenTelemetry Lambda
-layers, and associated [documentation](/docs/faas/) on how to monitor Amazon Web
+layers, and associated [documentation](/docs/platforms/faas/) on how to monitor Amazon Web
 Services (AWS) Lambdas.
 
 ## OTel FaaS repackaged
@@ -42,7 +42,7 @@ The FaaS SIG has addressed the above-mentioned shortcomings:
   Collector alongside auto-instrumentation layers for JavaScript, Java, and
   Python.
 - Added official community Lambda documentation to the OTel website under the
-  new [FaaS section](/docs/faas/).
+  new [FaaS section](/docs/platforms/faas/).
 
 ## What next
 

content/en/blog/2023/kubecon-na.md

@@ -105,7 +105,7 @@ with a backlog of issues created to guide further development.
 ## OpAMP in Kubernetes
 
 In OTel we have dedicated support for Kubernetes as a compute platform via the
-[OpenTelemetry Operator for Kubernetes](/docs/kubernetes/operator/). In this
+[OpenTelemetry Operator for Kubernetes](/docs/platforms/kubernetes/operator/). In this
 context, we're also working on OpAMP support in Kubernetes which will be
 available through a
 [bridge component](https://docs.google.com/document/d/1M8VLNe_sv1MIfu5bUR5OV_vrMBnAI7IJN-7-IAr37JY/)

content/en/blog/2023/lambda-release.md

@@ -81,7 +81,7 @@ There's much more -- be sure to check out the release notes!
 
 ## Project Updates
 
-KubeCon EU saw over ten thousand cloud-native developers gather in Amsterdam,
+KubeCon EU saw over ten thousand cloud native developers gather in Amsterdam,
 and a lot of you stopped by the OpenTelemetry booth to say hi! Hopefully some of
 you got your hands on our limited-edition KubeCon stickers... if not, well,
 there'll be more limited edition stickers. Just not for KubeCon, because it's

content/en/blog/2023/opamp-status/index.md

@@ -65,7 +65,7 @@ wanted to focus on:
    OTLP exporter.
 2. Individual Go modules that the Collector components rely upon must also be
    marked as stable as per the project's
-   [versioning guidelines](https://github.com/open-telemetry/opentelemetry-collector/blob/main/VERSIONING.md#public-api-expectations).
+   [versioning guidelines](https://github.com/open-telemetry/opentelemetry-collector/blob/main/VERSIONING.md#general-go-api-considerations).
 
 Aside from this, there were a few areas the contributors wanted to improve based
 on user feedback:

content/en/blog/2023/otel-in-focus-04.md

@@ -47,7 +47,7 @@ To become a code owner of one of the modules, you need to be a member of the
 OpenTelemetry organization and have a good working knowledge of the code you
 seek to maintain. To become a member of OpenTelemetry in GitHub, see the
 requirements in
-[Community membership](https://github.com/open-telemetry/community/blob/main/community-membership.md#requirements).
+[Community membership](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#requirements).
 
 If you satisfy all requirements,
 [open an issue](https://github.com/open-telemetry/opentelemetry-go-contrib/issues/new?assignees=&labels=&projects=&template=owner.md&title=).

content/en/blog/2024/collector-roadmap/index.md

@@ -285,7 +285,7 @@ The result is a configurable option unique to OpenTelemetry Java called
 what their memory mode is based on whether they read metric state concurrently
 or not. Right now you opt into the optimized memory behavior (which we call
 `MemoryMode.reusable_data`) via an
-[environment variable](https://github.com/open-telemetry/opentelemetry-java/tree/main/sdk-extensions/autoconfigure#exporters).
+[environment variable](/docs/languages/java/configuration/#properties-exporters).
 In the future, the optimized memory mode will be enabled by default, since only
 exceptional cases need concurrent access to the metric state. It turns out that
 the objects holding the metric state (`MetricData` in OpenTelemetry Java terms)