diff --git a/.github/component-label-map.yml b/.github/component-label-map.yml index d86a90b60d30..e1e0116a0080 100644 --- a/.github/component-label-map.yml +++ b/.github/component-label-map.yml @@ -10,6 +10,10 @@ lang:zh: - changed-files: - any-glob-to-any-file: - content/zh/** +lang:ja: + - changed-files: + - any-glob-to-any-file: + - content/ja/** sig:cpp: - changed-files: - any-glob-to-any-file: diff --git a/.github/workflows/check-i18n.yml b/.github/workflows/check-i18n.yml index 43ce869eb2f2..88d8f3033ab0 100644 --- a/.github/workflows/check-i18n.yml +++ b/.github/workflows/check-i18n.yml @@ -9,5 +9,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 + with: + fetch-depth: 0 # all - run: scripts/i18n-check.sh -u - run: .github/workflows/scripts/i18n-check-helper.sh diff --git a/.htmltest.yml b/.htmltest.yml index e45612215caf..53e80a8d75fb 100644 --- a/.htmltest.yml +++ b/.htmltest.yml @@ -10,11 +10,11 @@ IgnoreDirs: - ^blog/(\d+/)?page/\d+ IgnoreInternalURLs: # list of paths IgnoreURLs: # list of regexs of paths or URLs to be ignored - - ^(/zh)?/docs/languages/\w+/(api|examples|registry)/$ - - ^(/zh)?/docs/collector/registry/$ - - ^(/zh)?/docs/languages/net/(metrics-api|traces-api)/ - - ^((/zh)?/docs/migration/)?opencensus/$ - - ^/community/end-user/feedback-survey/$ + - ^(/..)?/docs/languages/\w+/(api|examples|registry)/$ + - ^(/..)?/docs/collector/registry/$ + - ^(/..)?/docs/languages/net/(metrics-api|traces-api)/ + - ^((/..)?/docs/migration/)?opencensus/$ + - ^(/community/end-user/)?feedback-survey/$ - ^https://deploy-preview-\d+--opentelemetry.netlify.app/ - ^https://www\.googletagmanager\.com diff --git a/archetypes/announcement.md b/archetypes/announcement.md new file mode 100644 index 000000000000..aad8bacfd084 --- /dev/null +++ b/archetypes/announcement.md @@ -0,0 +1,10 @@ +--- +title: {{ replaceRE "[-_]" " " .Name | title }} +date: {{ .Date | time.Format "2006-01-02" }} # Start date (optional) +expiryDate: {{ dateFormat "2006-01-02" .Date }} # End date (optional) +--- + + diff --git a/content/en/_index.md b/content/en/_index.md index 9a5f0e7fa4b5..cefdbafdd3bc 100644 --- a/content/en/_index.md +++ b/content/en/_index.md @@ -10,18 +10,6 @@ developer_note: The blocks/cover shortcode (used below) will use as a background image any image file containing "background" in its name. show_banner: true -limit_banner: 2 # Default to 2, adjust as needed -banners: - - message: - ' We are happy to announce that Elastic''s - donation of the [**eBPF profiling agent has been - accepted**](/blog/2024/elastic-contributes-continuous-profiling-agent)!' - to: 2024-07-25 - - message: - ' Join us for [**OTel Community Day** on - June - 25th](https://events.linuxfoundation.org/open-telemetry-community-day/)!' - to: 2024-06-25 ---
@@ -38,9 +26,9 @@ banners: @@ -49,8 +37,8 @@ banners: {{< /blocks/cover >}} @@ -62,7 +50,7 @@ generate, collect, and export telemetry data (metrics, logs, and traces) to help you analyze your software's performance and behavior. > OpenTelemetry is **generally available** across -> [several languages](/docs/languages/) and is suitable for use. +> [several languages](docs/languages/) and is suitable for use. {{% /blocks/lead %}} diff --git a/content/en/announcements/_index.md b/content/en/announcements/_index.md new file mode 100644 index 000000000000..7cc434bea326 --- /dev/null +++ b/content/en/announcements/_index.md @@ -0,0 +1,5 @@ +--- +title: Announcements +cascade: + type: docs +--- diff --git a/content/en/announcements/eBPF.md b/content/en/announcements/eBPF.md new file mode 100644 index 000000000000..971fc2fcf4d2 --- /dev/null +++ b/content/en/announcements/eBPF.md @@ -0,0 +1,8 @@ +--- +title: eBPF +date: 2024-06-07 +expiryDate: 2024-07-25 +--- + +Elastic's **eBPF profiling agent** is now part of OTel. +[Learn more](/blog/2024/elastic-contributes-continuous-profiling-agent) diff --git a/content/en/announcements/otel-community-day.md b/content/en/announcements/otel-community-day.md new file mode 100644 index 000000000000..23046e424222 --- /dev/null +++ b/content/en/announcements/otel-community-day.md @@ -0,0 +1,10 @@ +--- +title: OTel Community Day +date: 2024-04-05 +expiryDate: 2024-06-25 +weight: -1 # top +--- + + Join us for +[**OTel Community Day**](https://events.linuxfoundation.org/open-telemetry-community-day/) +on June 25th diff --git a/content/en/blog/2024/elastic-contributes-continuous-profiling-agent.md b/content/en/blog/2024/elastic-contributes-continuous-profiling-agent.md index 4010bea3406b..05d65358f7e9 100644 --- a/content/en/blog/2024/elastic-contributes-continuous-profiling-agent.md +++ b/content/en/blog/2024/elastic-contributes-continuous-profiling-agent.md @@ -1,11 +1,10 @@ --- title: Elastic Contributes its Continuous Profiling Agent to OpenTelemetry -linkTitle: Elastic Contributes Profiling Agent # Mandatory, make sure that your short title. +linkTitle: Elastic Contributes Profiling Agent date: 2024-06-07 # prettier-ignore cSpell:ignore: Bahubali Christos Dmitry Filimonov Geisendörfer Halliday Kalkanis Shetti -author: - >- # If you have only one author, then add the single name on this line in quotes. +author: > [Bahubali Shetti](https://github.com/bshetti) (Elastic), [Alexander Wert](https://github.com/AlexanderWert) (Elastic), [Morgan McLean](https://github.com/mtwo) (Splunk), [Ryan diff --git a/content/en/community/end-user/_index.md b/content/en/community/end-user/_index.md index 584d363b9b36..3d0d1e724d1f 100644 --- a/content/en/community/end-user/_index.md +++ b/content/en/community/end-user/_index.md @@ -18,7 +18,7 @@ right place! [OpenTelemetry YouTube channel](https://www.youtube.com/@otel-official) - To provide feedback and help prioritize issues: - Participate in a [direct interview/feedback session](interviews-feedback/) - - Take a [survey](/community/end-user/feedback-survey/) + - Take a [survey](feedback-survey/) - Join a panel discussion (more info coming soon!) - Vote on issues (more info coming soon!) diff --git a/content/en/docs/_index.md b/content/en/docs/_index.md index 2b776e2f0d49..65a0abee5c2c 100644 --- a/content/en/docs/_index.md +++ b/content/en/docs/_index.md @@ -8,13 +8,12 @@ aliases: [/docs/workshop/*] OpenTelemetry, also known as OTel, is a vendor-neutral open source [Observability](concepts/observability-primer/#what-is-observability) framework for instrumenting, generating, collecting, and exporting telemetry data such as -[traces](/docs/concepts/signals/traces/), -[metrics](/docs/concepts/signals/metrics/), and -[logs](/docs/concepts/signals/logs/). +[traces](concepts/signals/traces/), [metrics](concepts/signals/metrics/), and +[logs](concepts/signals/logs/). As an industry-standard, OpenTelemetry is [supported by more than 40 observability vendors](/ecosystem/vendors/), -integrated by many [libraries, services, and apps](/ecosystem/integrations), and -adopted by [numerous end users](/ecosystem/adopters). +integrated by many [libraries, services, and apps](/ecosystem/integrations/), +and adopted by [numerous end users](/ecosystem/adopters/). ![OpenTelemetry Reference Architecture](/img/otel-diagram.svg) diff --git a/content/en/docs/contributing/_index.md b/content/en/docs/contributing/_index.md index 217cdbdfe7d5..5a16627ed0fa 100644 --- a/content/en/docs/contributing/_index.md +++ b/content/en/docs/contributing/_index.md @@ -600,6 +600,53 @@ Keep the following in mind when filing an issue: Respect your fellow contributors. For example, "The docs are terrible" is not helpful or polite feedback. +## Announcement management + +An announcement is a _regular Hugo page_ contained under the `announcements` +section of a locale. This means that we leverage Hugo's builtin handling of page +dates (future or expired), internationalization, and more, to automatically show +or hide banners depending on the build date, determine banner ordering, handle +fall back to English banners, etc. + +> Announcements are currently used as banners only. We _might_ eventually +> support slightly more general announcements as well. + +### Creating an announcement + +To add a new announcement, create an announcement markdown file under the +`announcements` folder of your localization using the following command: + +```sh +hugo new --kind announcement content/YOUR-LOCALE/announcements/announcement-file-name.md +``` + +Adjust according to your desired locale and file name. Add the announcement text +as the body of the page. + +> For banners, the announcement body should be a short phrase. + +{{% alert title="For localizations" %}} + +If you are creating a **locale specific announcement override**, make sure that +you use the **same filename** as the English language announcement. + +{{% /alert %}} + +### Announcement list + +Any given announcement will appear in a site build when the build date falls +between the `date` and `expiryDate` fields of the announcement. When those +fields are missing they are assumed to be "now" and "forever", respectively. + +Announcements will appear in the standard page order as determined using Hugo's +[Regular pages](https://gohugo.io/methods/site/regularpages/) function. That is, +the "lightest" announcements (by `weight`) will appear first; when weights are +the same or unspecified, the most recent announcements (by `date`) will appear +first, etc. + +So, if you want to force an announcement to the top, use a negative `weight` in +the front matter. + ## Contribute to other repositories OpenTelemetry is an open source project, and we gladly accept new contributions diff --git a/content/en/docs/getting-started/_index.md b/content/en/docs/getting-started/_index.md index 2b60257680a5..b90ad2b72f5b 100644 --- a/content/en/docs/getting-started/_index.md +++ b/content/en/docs/getting-started/_index.md @@ -23,8 +23,8 @@ observability with OpenTelemetry looks like! -[^1]: If none of these roles apply to you, [let us know!][]. +[^1]: If none of these roles apply to you, [let us know][]. [demo]: /ecosystem/demo/ -[let us know!]: +[let us know]: https://github.com/open-telemetry/opentelemetry.io/issues/new?title=Add%20a%20new%20persona:%20My%20Persona&body=Provide%20a%20description%20of%20your%20role%20and%20responsibilities%20and%20what%20your%20observability%20goals%20are diff --git a/content/en/docs/getting-started/dev.md b/content/en/docs/getting-started/dev.md index 63063e4f9a96..73c8175a320a 100644 --- a/content/en/docs/getting-started/dev.md +++ b/content/en/docs/getting-started/dev.md @@ -13,27 +13,27 @@ OpenTelemetry can help you! To accomplish your goals of having your dependencies instrumented automatically and instrumenting your own code with our API manually, we recommend that you learn the following concepts first: -- [What is OpenTelemetry?](/docs/what-is-opentelemetry/) -- [How can I add instrumentation to my code base?](/docs/concepts/instrumentation/code-based/) +- [What is OpenTelemetry?](../../what-is-opentelemetry/) +- [How can I add instrumentation to my code base?](../../concepts/instrumentation/code-based/) If you develop libraries, frameworks or middleware that is used as a dependency within other software, we recommend that you learn how you can provide telemetry natively: -- [How can I add native instrumentation to my library?](/docs/concepts/instrumentation/libraries/) +- [How can I add native instrumentation to my library?](../../concepts/instrumentation/libraries/) Next, you can deep dive into the documentations for the -[language](/docs/languages/) you are using: - -- [C++](/docs/languages/cpp/) -- [.NET](/docs/languages/net/) -- [Erlang / Elixir](/docs/languages/erlang/) -- [Go](/docs/languages/go/) -- [Java](/docs/languages/java/) -- [JavaScript / TypeScript](/docs/languages/js/) -- [PHP](/docs/languages/php/) -- [Python](/docs/languages/python/) -- [Ruby](/docs/languages/ruby/) -- [Rust](/docs/languages/rust/) -- [Swift](/docs/languages/swift/) -- [Other](/docs/languages/other/) +[language](../../languages/) you are using: + +- [C++](../../languages/cpp/) +- [.NET](../../languages/net/) +- [Erlang / Elixir](../../languages/erlang/) +- [Go](../../languages/go/) +- [Java](../../languages/java/) +- [JavaScript / TypeScript](../../languages/js/) +- [PHP](../../languages/php/) +- [Python](../../languages/python/) +- [Ruby](../../languages/ruby/) +- [Rust](../../languages/rust/) +- [Swift](../../languages/swift/) +- [Other](../../languages/other/) diff --git a/content/en/docs/getting-started/ops.md b/content/en/docs/getting-started/ops.md index 24a16a0d0980..ac60198d37fa 100644 --- a/content/en/docs/getting-started/ops.md +++ b/content/en/docs/getting-started/ops.md @@ -14,10 +14,10 @@ OpenTelemetry can help you! To accomplish your goal of getting telemetry out of applications without touching their code, we recommend that you learn the following: -- [What is OpenTelemetry?](/docs/what-is-opentelemetry/) -- [How can I instrument applications without touching their code?](/docs/concepts/instrumentation/zero-code/) -- [How can I set up a collector?](/docs/collector/) -- [How can I get automation for Kubernetes with the OpenTelemetry Operator?](/docs/kubernetes/operator/) +- [What is OpenTelemetry?](../../what-is-opentelemetry/) +- [How can I instrument applications without touching their code?](../../concepts/instrumentation/zero-code/) +- [How can I set up a collector?](../../collector/) +- [How can I get automation for Kubernetes with the OpenTelemetry Operator?](../../kubernetes/operator/) If you are looking for a set of applications to try things out, you will find -our official [OpenTelemetry demo](/ecosystem/demo/) useful! +our official [OpenTelemetry demo](/ecosystem/demo/) useful. diff --git a/content/en/docs/languages/go/getting-started.md b/content/en/docs/languages/go/getting-started.md index 33f95abf625f..68ff65834062 100644 --- a/content/en/docs/languages/go/getting-started.md +++ b/content/en/docs/languages/go/getting-started.md @@ -378,6 +378,7 @@ Modify `rolldice.go` to include custom instrumentation using OpenTelemetry API: package main import ( + "fmt" "io" "log" "math/rand" @@ -388,7 +389,6 @@ import ( "go.opentelemetry.io/otel" "go.opentelemetry.io/otel/attribute" "go.opentelemetry.io/otel/metric" - "go.opentelemetry.io/otel/sdk/instrumentation" ) const name = "rolldice" diff --git a/content/en/docs/languages/go/instrumentation.md b/content/en/docs/languages/go/instrumentation.md index c9b61dc8ddbe..873614be8594 100644 --- a/content/en/docs/languages/go/instrumentation.md +++ b/content/en/docs/languages/go/instrumentation.md @@ -534,6 +534,35 @@ func removeItem() { } ``` +### Using Gauges + +Gauges are used to measure non-additive values when changes occur. + +For example, here's how you might report the current speed of a CPU fan: + +```go +import ( + "net/http" + + "go.opentelemetry.io/otel/metric" +) + +func init() { + speedGauge, err := meter.Int64Gauge( + "cpu.fan.speed", + metric.WithDescription("Speed of CPU fan"), + metric.WithUnit("RPM"), + ) + if err != nil { + panic(err) + } + http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) { + // hard-code 1500 RPM for demonstrative purposes + speedGauge.Record(r.Context(), 1500) + }) +} +``` + ### Using Histograms Histograms are used to measure a distribution of values over time. diff --git a/content/en/docs/languages/java/_index.md b/content/en/docs/languages/java/_index.md index eaf9e8357510..76d1aad34287 100644 --- a/content/en/docs/languages/java/_index.md +++ b/content/en/docs/languages/java/_index.md @@ -7,7 +7,7 @@ aliases: [/java, /java/metrics, /java/tracing] cascade: vers: instrumentation: 2.4.0 - otel: 1.38.0 + otel: 1.39.0 semconv: 1.25.0 weight: 18 --- diff --git a/content/ja/_index.md b/content/ja/_index.md index 3e3ddc362b9a..52e4e734e687 100644 --- a/content/ja/_index.md +++ b/content/ja/_index.md @@ -2,8 +2,8 @@ title: OpenTelemetry description: >- 効果的な観測を可能にする、高品質でユビキタスかつポータブルなテレメトリー -developer_note: - blocks/coverコラム(以下で使用)は、ファイル名に "background" を含む画像ファイルを背景画像として使用します。 +developer_note: blocks/coverコラム(以下で使用)は、ファイル名に "background" を含む画像ファイルを背景画像として使用します。 +show_banner: true default_lang_commit: 902043db --- diff --git a/content/ja/announcements/otel-community-day.md b/content/ja/announcements/otel-community-day.md new file mode 100644 index 000000000000..04ddfac8a4e0 --- /dev/null +++ b/content/ja/announcements/otel-community-day.md @@ -0,0 +1,12 @@ +--- +title: OTel Community Day +date: 2024-04-05 +expiryDate: 2024-06-25 +weight: -1 # top +default_lang_commit: 788509efd404ba35dd113b4f37bae96ca7558e3e +--- + + +6月25日に開催される +[**OTel コミュニティデー**](https://events.linuxfoundation.org/open-telemetry-community-day/) +にご参加ください diff --git a/content/ja/docs/what-is-opentelemetry.md b/content/ja/docs/what-is-opentelemetry.md index 38e883c08eeb..e6a7fb23693c 100644 --- a/content/ja/docs/what-is-opentelemetry.md +++ b/content/ja/docs/what-is-opentelemetry.md @@ -29,8 +29,8 @@ OpenTelemetryの主な目的は、あなたのアプリケーションやシス OpenTelemetryは、2つの重要な原則に従いながら、オブザーバビリティの需要を満たしています。 - 1. あなたが生成したデータはあなたのものです。ベンダーのロックインはありません。 - 2. APIと規約は1セットだけ覚えれば良いです。 +1. あなたが生成したデータはあなたのものです。ベンダーのロックインはありません。 +2. APIと規約は1セットだけ覚えれば良いです。 この2つの原則を組み合わせることで、現代のコンピューティングの世界で必要とされる柔軟性をチームや組織に与えられます。 diff --git a/content/zh/_index.md b/content/zh/_index.md index a07cf2e408c9..938e1e187740 100644 --- a/content/zh/_index.md +++ b/content/zh/_index.md @@ -6,6 +6,7 @@ show_banner: true developer_note: 下文所用的 blocks/cover 短代码将使用文件名中包含 "background" 的图像文件作为背景图。 +show_banner: true default_lang_commit: 6e35a949 --- diff --git a/content/zh/announcements/otel-community-day.md b/content/zh/announcements/otel-community-day.md new file mode 100644 index 000000000000..fc1f3ae5bf48 --- /dev/null +++ b/content/zh/announcements/otel-community-day.md @@ -0,0 +1,12 @@ +--- +title: OTel Community Day +date: 2024-04-05 +expiryDate: 2024-06-25 +weight: -1 # top +default_lang_commit: 788509efd404ba35dd113b4f37bae96ca7558e3e +--- + + +加入我们,参加 +[**OTel 社区日**](https://events.linuxfoundation.org/open-telemetry-community-day/) +6月25日 diff --git a/content/zh/docs/demo/_index.md b/content/zh/docs/demo/_index.md index ad76b124e689..19e7f1ee6857 100644 --- a/content/zh/docs/demo/_index.md +++ b/content/zh/docs/demo/_index.md @@ -22,18 +22,18 @@ default_lang_commit: b7ee690154aacc8d6e43636af00743994fb6dc27 想要了解特定编程语言的工具是如何工作的?从这里开始: -| 语言 | 自动插桩 | 插桩库 | 手动插桩 | -| ---------- | ------------------- | -------------------- | ------------------------------------ | -| .NET | | [购物车服务](services/cart/) | [购物车服务](services/cart/) | -| C++ | | | [货币服务](services/currency/) | -| Go | | [会计服务](services/accounting/)、[结账服务](services/checkout/)、[产品目录服务](services/product-catalog/) | [结账服务](services/checkout/)、 [产品目录服务](services/product-catalog/) | -| Java | [广告服务](services/ad/) | | [广告服务](services/ad/) | -| JavaScript | | [前端](services/frontend/) | [前端](services/frontend/)、[支付服务](services/payment/) | -| Kotlin | | [欺诈检测服务](services/fraud-detection/) | | -| PHP | | [报价服务](services/quote/) | [报价服务](services/quote/) | -| Python | [推荐服务](services/recommendation/) | | [推荐服务](services/recommendation/) | -| Ruby | | [电子邮件服务](services/email/) | [电子邮件服务](services/email/) | -| Rust | | [发货服务](services/shipping/) | [发货服务](services/shipping/) | +| 语言 | 自动插桩 | 插桩库 | 手动插桩 | +| ---------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| .NET | | [购物车服务](services/cart/) | [购物车服务](services/cart/) | +| C++ | | | [货币服务](services/currency/) | +| Go | | [会计服务](services/accounting/)、[结账服务](services/checkout/)、[产品目录服务](services/product-catalog/) | [结账服务](services/checkout/)、 [产品目录服务](services/product-catalog/) | +| Java | [广告服务](services/ad/) | | [广告服务](services/ad/) | +| JavaScript | | [前端](services/frontend/) | [前端](services/frontend/)、[支付服务](services/payment/) | +| Kotlin | | [欺诈检测服务](services/fraud-detection/) | | +| PHP | | [报价服务](services/quote/) | [报价服务](services/quote/) | +| Python | [推荐服务](services/recommendation/) | | [推荐服务](services/recommendation/) | +| Ruby | | [电子邮件服务](services/email/) | [电子邮件服务](services/email/) | +| Rust | | [发货服务](services/shipping/) | [发货服务](services/shipping/) | ## 服务文档 diff --git a/data/registry/exporter-dotnet-console.yml b/data/registry/exporter-dotnet-console.yml index 23bdaa81d9f4..48a11181fd85 100644 --- a/data/registry/exporter-dotnet-console.yml +++ b/data/registry/exporter-dotnet-console.yml @@ -15,4 +15,4 @@ createdAt: 2022-11-07 package: registry: nuget name: OpenTelemetry.Exporter.Console - version: 1.9.0-alpha.1 + version: 1.9.0-rc.1 diff --git a/data/registry/exporter-dotnet-inmemory.yml b/data/registry/exporter-dotnet-inmemory.yml index 00acae9683f0..0f320bf35c46 100644 --- a/data/registry/exporter-dotnet-inmemory.yml +++ b/data/registry/exporter-dotnet-inmemory.yml @@ -17,4 +17,4 @@ createdAt: 2022-11-07 package: registry: nuget name: OpenTelemetry.Exporter.InMemory - version: 1.9.0-alpha.1 + version: 1.9.0-rc.1 diff --git a/data/registry/instrumentation-js-azure-sdk.yml b/data/registry/instrumentation-js-azure-sdk.yml index c3c4395983f2..cda7ebc702a8 100644 --- a/data/registry/instrumentation-js-azure-sdk.yml +++ b/data/registry/instrumentation-js-azure-sdk.yml @@ -13,5 +13,9 @@ description: Instrumentation for Azure SDK for JavaScript (Track 2 libraries). authors: - name: Microsoft Authors urls: - repo: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core#open-telemetry + repo: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/instrumentation/opentelemetry-instrumentation-azure-sdk +package: + name: '@azure/opentelemetry-instrumentation-azure-sdk' + registry: npm + version: 1.0.0-beta.5 createdAt: 2021-12-16 diff --git a/data/registry/instrumentation-js-langchain.yml b/data/registry/instrumentation-js-langchain.yml index bb2d1f852c8c..f22d240c8989 100644 --- a/data/registry/instrumentation-js-langchain.yml +++ b/data/registry/instrumentation-js-langchain.yml @@ -18,3 +18,4 @@ createdAt: 2024-06-05 package: registry: npm name: '@arizeai/openinference-instrumentation-langchain' + version: 0.0.6 diff --git a/data/registry/instrumentation-js-openai.yml b/data/registry/instrumentation-js-openai.yml index 1171d94d39da..b5aa6175a1d7 100644 --- a/data/registry/instrumentation-js-openai.yml +++ b/data/registry/instrumentation-js-openai.yml @@ -18,3 +18,4 @@ createdAt: 2024-06-05 package: registry: npm name: '@arizeai/openinference-instrumentation-openai' + version: 0.3.1 diff --git a/gulp-src/lint-md.js b/gulp-src/lint-md.js index 513c8d37bf49..2866588575a3 100644 --- a/gulp-src/lint-md.js +++ b/gulp-src/lint-md.js @@ -6,13 +6,15 @@ const markdownlint = require('markdownlint'); const { taskArgs, trimBlankLinesFromArray } = require('./_util'); const fs = require('fs'); -const defaultGlob = '**/*.md'; +const defaultGlobs = ['**/*.md']; const markdownFiles = [ '!.github/**', '!content-modules/**', + '!examples/**', '!layouts/**', '!node_modules/**', '!scripts/registry-scanner/node_modules/**', + '!tools/examples/**', '!themes/**', '!tmp/**', ]; @@ -121,13 +123,28 @@ function applyFixesToFileContent(content, issue) { return lines.join('\n'); } +function logFiles(debug) { + return through2.obj(function (file, enc, cb) { + if (debug) { + console.log('Processing file:', file.path); + } + cb(null, file); + }); +} + function lintMarkdown() { const argv = taskArgs().options({ glob: { alias: 'g', - type: 'string', - description: 'Glob of files to run through markdownlint.', - default: defaultGlob, + type: 'array', + description: + 'Globs of files to run through markdownlint. List flag more than once for multiple values.', + default: defaultGlobs, + }, + debug: { + type: 'boolean', + description: 'Output debugging information.', + default: false, }, fix: { type: 'boolean', @@ -142,8 +159,14 @@ function lintMarkdown() { } fix = argv.fix; + const globs = [...argv.glob, ...markdownFiles]; + if (argv.debug) { + console.log('Globs being used:', globs); + } + return gulp - .src([argv.glob, ...markdownFiles]) + .src(globs, { followSymlinks: false }) + .pipe(logFiles(argv.debug)) .pipe(through2.obj(markdownLintFile)) .on('end', () => { const fileOrFiles = 'file' + (numFilesProcessed == 1 ? '' : 's'); diff --git a/layouts/_default/baseof.html b/layouts/_default/baseof.html index 90e648455bf6..9b5adbad32d2 100644 --- a/layouts/_default/baseof.html +++ b/layouts/_default/baseof.html @@ -10,7 +10,7 @@ {{ partial "navbar.html" . }}