From 94efbd39125416c544fa69dd4f60120027bfce2a Mon Sep 17 00:00:00 2001 From: crocmons Date: Sat, 26 Oct 2024 03:45:21 +0600 Subject: [PATCH 1/7] Add tooltip feature with necessary files only --- assets/js/registrySearch.js | 5 + .../partials/ecosystem/registry/entry.html | 233 +++++++++--------- 2 files changed, 127 insertions(+), 111 deletions(-) diff --git a/assets/js/registrySearch.js b/assets/js/registrySearch.js index d91c590585a3..c15796154337 100644 --- a/assets/js/registrySearch.js +++ b/assets/js/registrySearch.js @@ -239,3 +239,8 @@ function parseUrlParams() { selectedLanguage = urlParams.get('language') || 'all'; selectedComponent = urlParams.get('component') || 'all'; } + +var tooltipTriggerList = [].slice.call(document.querySelectorAll('[data-bs-toggle="tooltip"]')) +var tooltipList = tooltipTriggerList.map(function (tooltipTriggerEl) { + return new bootstrap.Tooltip(tooltipTriggerEl) +}) diff --git a/layouts/partials/ecosystem/registry/entry.html b/layouts/partials/ecosystem/registry/entry.html index 9a282c4db0b9..e4234e0dc59a 100644 --- a/layouts/partials/ecosystem/registry/entry.html +++ b/layouts/partials/ecosystem/registry/entry.html @@ -1,95 +1,100 @@ {{ $languageNames := .languageNames -}} {{ with .value -}} - {{ - $remoteRegistries := dict - "npm" (dict - "urlPattern" "https://npmjs.com/package/%s" - "installTemplate" "ecosystem/registry/quickinstall/default.md" - "installLine" "npm install %s" - "icon" "fab fa-npm") - "packagist" (dict - "urlPattern" "https://packagist.org/packages/%s" - "installLine" "composer require %s" - "installTemplate" "ecosystem/registry/quickinstall/default.md" - "icon" "fa-solid fa-box-open") - "gems" (dict - "urlPattern" "https://rubygems.org/gems/%s" - "installLine" "gem install %s" - "installTemplate" "ecosystem/registry/quickinstall/default.md" - "icon" "fa-solid fa-gem") - "go" (dict - "urlPattern" "https://pkg.go.dev/%s" - "installLine" "go get %s" - "installTemplate" "ecosystem/registry/quickinstall/default.md" - "icon" "fa-brands fa-golang") - "go-collector" (dict - "urlPattern" "https://pkg.go.dev/%s" - "installTemplate" "ecosystem/registry/quickinstall/collector.md" - "icon" "fa-solid fa-box-open") - "nuget" (dict - "urlPattern" "https://www.nuget.org/packages/%s" - "installLine" "dotnet add package %s" - "installTemplate" "ecosystem/registry/quickinstall/default.md" - "icon" "fa-solid fa-box-open") - "pip" (dict - "urlPattern" "https://pypi.org/project/%s" - "installLine" "pip install %s" - "installTemplate" "ecosystem/registry/quickinstall/default.md" - "icon" "fa-brands fa-python") - "hex" (dict - "urlPattern" "https://hex.pm/packages/%s" - "installTemplate" "ecosystem/registry/quickinstall/hex.md" - "icon" "fa-brands fa-erlang") - "crates" (dict - "urlPattern" "https://crates.io/crates/%s" - "installLine" "cargo add %s" - "installTemplate" "ecosystem/registry/quickinstall/default.md" - "icon" "fab fa-rust") - -}} +{{ +$remoteRegistries := dict +"npm" (dict +"urlPattern" "https://npmjs.com/package/%s" +"installTemplate" "ecosystem/registry/quickinstall/default.md" +"installLine" "npm install %s" +"icon" "fab fa-npm") +"packagist" (dict +"urlPattern" "https://packagist.org/packages/%s" +"installLine" "composer require %s" +"installTemplate" "ecosystem/registry/quickinstall/default.md" +"icon" "fa-solid fa-box-open") +"gems" (dict +"urlPattern" "https://rubygems.org/gems/%s" +"installLine" "gem install %s" +"installTemplate" "ecosystem/registry/quickinstall/default.md" +"icon" "fa-solid fa-gem") +"go" (dict +"urlPattern" "https://pkg.go.dev/%s" +"installLine" "go get %s" +"installTemplate" "ecosystem/registry/quickinstall/default.md" +"icon" "fa-brands fa-golang") +"go-collector" (dict +"urlPattern" "https://pkg.go.dev/%s" +"installTemplate" "ecosystem/registry/quickinstall/collector.md" +"icon" "fa-solid fa-box-open") +"nuget" (dict +"urlPattern" "https://www.nuget.org/packages/%s" +"installLine" "dotnet add package %s" +"installTemplate" "ecosystem/registry/quickinstall/default.md" +"icon" "fa-solid fa-box-open") +"pip" (dict +"urlPattern" "https://pypi.org/project/%s" +"installLine" "pip install %s" +"installTemplate" "ecosystem/registry/quickinstall/default.md" +"icon" "fa-brands fa-python") +"hex" (dict +"urlPattern" "https://hex.pm/packages/%s" +"installTemplate" "ecosystem/registry/quickinstall/hex.md" +"icon" "fa-brands fa-erlang") +"crates" (dict +"urlPattern" "https://crates.io/crates/%s" +"installLine" "cargo add %s" +"installTemplate" "ecosystem/registry/quickinstall/default.md" +"icon" "fab fa-rust") +-}} {{ $isNative := and (or (eq .registryType "instrumentation") (eq .registryType "application integration")) (.isNative) }} + + native + {{ $isFirstParty := and (or (eq .registryType "instrumentation") (eq .registryType "application integration")) (.isFirstParty) }} - {{ $currentTime := (time now) -}} - {{ $delta := $currentTime.Sub (time.AsTime .createdAt) -}} - {{ $isNew := lt $delta.Hours 730 -}} - {{ $usedInDemo := and (isset . "urls") (isset .urls "demo") }} - {{ $deprecated := and (isset . "deprecated") (isset .deprecated "reason") }} - {{ $package := "" -}} - {{ if and (.package) (isset $remoteRegistries .package.registry) -}} - {{ $package = merge .package (index $remoteRegistries .package.registry) -}} - {{ $package = merge $package (dict "type" .registryType) -}} - {{ end -}} - {{ $highlightStyle := "" -}} - {{ if $isNew -}} - {{ $highlightStyle = "border-info" -}} - {{ end -}} - {{ if $isNative -}} - {{ $highlightStyle = "border-success" -}} - {{ end -}} - {{ if $isFirstParty -}} - {{ $highlightStyle = "border-success" -}} - {{ end -}} - {{ if $usedInDemo -}} - {{ $highlightStyle = "border-secondary" -}} - {{ end -}} - {{ if $deprecated -}} - {{ $highlightStyle = "border-danger" -}} - {{ end -}} - {{ $primaryUrl := "" -}} - {{ if .urls.repo -}} - {{ $primaryUrl = .urls.repo -}} - {{ else if .urls.website -}} - {{ $primaryUrl = .urls.website -}} - {{ else if .urls.docs -}} - {{ errorf "The %q registry entry requires a repo or website URL." .title }} - {{ end -}} - {{ $primaryHref := printf "href=%q" $primaryUrl | safeHTMLAttr -}} -
  • -
    +{{ $currentTime := (time now) -}} +{{ $delta := $currentTime.Sub (time.AsTime .createdAt) -}} +{{ $isNew := lt $delta.Hours 730 -}} +{{ $usedInDemo := and (isset . "urls") (isset .urls "demo") }} +{{ $deprecated := and (isset . "deprecated") (isset .deprecated "reason") }} +{{ $package := "" -}} +{{ if and (.package) (isset $remoteRegistries .package.registry) -}} +{{ $package = merge .package (index $remoteRegistries .package.registry) -}} +{{ $package = merge $package (dict "type" .registryType) -}} +{{ end -}} +{{ $highlightStyle := "" -}} +{{ if $isNew -}} +{{ $highlightStyle = "border-info" -}} +{{ end -}} +{{ if $isNative -}} +{{ $highlightStyle = "border-success" -}} +{{ end -}} +{{ if $isFirstParty -}} +{{ $highlightStyle = "border-success" -}} +{{ end -}} +{{ if $usedInDemo -}} +{{ $highlightStyle = "border-secondary" -}} +{{ end -}} +{{ if $deprecated -}} +{{ $highlightStyle = "border-danger" -}} +{{ end -}} +{{ $primaryUrl := "" -}} +{{ if .urls.repo -}} +{{ $primaryUrl = .urls.repo -}} +{{ else if .urls.website -}} +{{ $primaryUrl = .urls.website -}} +{{ else if .urls.docs -}} +{{ errorf "The %q registry entry requires a repo or website URL." .title }} +{{ end -}} +{{ $primaryHref := printf "href=%q" $primaryUrl | safeHTMLAttr -}} +
  • +

    - {{- .title | markdownify -}} + {{- .title | markdownify -}}
    {{ if $isNew -}} @@ -105,7 +110,7 @@

    OTel Demo {{ end -}} {{ if $deprecated -}} - deprecated + deprecated {{ end -}} {{ if .cncfProjectLevel -}} @@ -116,37 +121,38 @@

    - by - {{ range $index, $author := .authors -}} + by + {{ range $index, $author := .authors -}} {{ if $index }}, {{ end }} {{ if eq $author.name "OpenTelemetry Authors" -}} - 🔭 {{ $author.name }} 🔭 + 🔭 {{ $author.name }} 🔭 {{ else if isset $author "url" }} - {{ $href := printf "href=%q" $author.url | safeHTMLAttr -}} - {{ $author.name }} + {{ $href := printf "href=%q" $author.url | safeHTMLAttr -}} + {{ $author.name }} {{ else -}} - {{ $author.name -}} + {{ $author.name -}} + {{ end -}} {{ end -}} - {{ end -}}

    {{ if $deprecated -}} - + {{ end -}} {{- .description | markdownify -}}
    {{ with $package -}} - {{ if not (eq .quickInstall false) }} -
    Quick Install
    -

    {{ (partial .installTemplate .) | markdownify -}} -

    - {{ end -}} + {{ if not (eq .quickInstall false) }} +
    Quick Install
    +

    {{ (partial .installTemplate .) | markdownify -}} +

    + + {{ end -}} {{- end -}}
    @@ -167,7 +173,7 @@
    Quick Install
    {{ $languageNames.Get . | default (humanize .) }}
    - Language + Language

    • {{- end }} @@ -177,7 +183,7 @@
    Quick Install
    {{ . | humanize }}
    - Component + Component {{- end -}} @@ -187,7 +193,7 @@
    Quick Install
    {{ . }}
    - License + License {{- end -}} @@ -198,15 +204,19 @@
    Quick Install
    {{ with .urls.website -}} {{ $websiteHref := printf "href=%q" . | safeHTMLAttr -}} -  Website +  Website {{- end -}} {{ with .urls.docs -}} {{ $docsHref := printf "href=%q" . | safeHTMLAttr -}} -  Documentation +  Documentation {{- end -}} {{ with $package -}} {{ $packageUrl := printf "href=%q" (printf .urlPattern .name) | safeHTMLAttr -}} -  Package Details ({{ .registry }}) + +  Package Details ({{ .registry }}) + {{- end -}} {{ with .urls.repo -}} {{ $icon := cond ( hasPrefix . "https://github.com/" ) "fa-brands fa-github" "fab fa-git-alt" -}} @@ -215,8 +225,9 @@
    Quick Install
    {{- end -}} {{ with .urls.demo -}} {{ $demoUrl := printf "href=%q" (printf .) | safeHTMLAttr -}} -  Demo Service +  Demo Service {{- end -}} - - - {{ end -}} + + +{{ end -}} \ No newline at end of file From af60cf10147504e98c61f3c2f5603942e07c236b Mon Sep 17 00:00:00 2001 From: crocmons Date: Sat, 26 Oct 2024 20:29:30 +0600 Subject: [PATCH 2/7] resolved all the changes requested --- content/en/ecosystem/registry/help.md | 48 +++++++++++++++++++ .../partials/ecosystem/registry/entry.html | 37 ++++++++++---- 2 files changed, 77 insertions(+), 8 deletions(-) create mode 100644 content/en/ecosystem/registry/help.md diff --git a/content/en/ecosystem/registry/help.md b/content/en/ecosystem/registry/help.md new file mode 100644 index 000000000000..6ddc3ffa7262 --- /dev/null +++ b/content/en/ecosystem/registry/help.md @@ -0,0 +1,48 @@ +# Component Types Help + +This page provides an overview of the different types of components in the OpenTelemetry ecosystem, including examples and explanations. + +## Component Types + +### Application Integration +- **Description**: Components that help integrate OpenTelemetry into existing applications or services. +- **Example**: Libraries that enable the export of telemetry data in OpenTelemetry formats. + +### Core +- **Description**: Fundamental components that are essential for OpenTelemetry's core functionality. +- **Example**: Core SDKs and libraries that provide basic tracing and metrics support. + +### Exporter +- **Description**: Components that handle exporting telemetry data to various backends. +- **Example**: Exporters that send telemetry data to cloud platforms or monitoring services. + +### Extension +- **Description**: Additional features that extend the capabilities of the OpenTelemetry Collector. +- **Example**: Plugins or modules that add specific functionalities to the Collector. + +### Instrumentation +- **Description**: Libraries for specific programming languages that automatically capture telemetry data from applications. +- **Example**: Java Util Logging Instrumentation for capturing logs in Java applications. + +### Log Bridge +- **Description**: Bridges between OpenTelemetry and logging systems, allowing logs to be processed with telemetry data. +- **Example**: Adapters that connect application logs with OpenTelemetry systems. + +### Processor +- **Description**: Components that modify or enrich telemetry data before it's exported. +- **Example**: Processors that filter or add metadata to spans before exporting. + +### Receiver +- **Description**: Components responsible for receiving telemetry data in various formats. +- **Example**: Receivers that support multiple telemetry protocols, like OTLP or Jaeger. + +### Resource Detector +- **Description**: Automatically detects resource information, such as cloud environment metadata. +- **Example**: Components that identify and add resource tags to telemetry data. + +### Utilities +- **Description**: Miscellaneous helper tools and libraries that aid in the management and processing of telemetry data. +- **Example**: Utility libraries for handling common data transformations or protocol conversions. + +## Additional Resources +- For more information on licenses, visit [Open Source Licenses](https://opensource.org/licenses). diff --git a/layouts/partials/ecosystem/registry/entry.html b/layouts/partials/ecosystem/registry/entry.html index e4234e0dc59a..c41cf4df4128 100644 --- a/layouts/partials/ecosystem/registry/entry.html +++ b/layouts/partials/ecosystem/registry/entry.html @@ -110,7 +110,7 @@

    OTel Demo {{ end -}} {{ if $deprecated -}} - deprecated + deprecated {{ end -}} {{ if .cncfProjectLevel -}} @@ -173,7 +173,17 @@
    Quick Install
    {{ $languageNames.Get . | default (humanize .) }}
    - Language + {{ if eq (replace (lower .) " " "") "collector" }} + + Collector + + + {{ else }} + + {{ . }} + + {{ end }} {{- end }} @@ -183,7 +193,9 @@
    Quick Install
    {{ . | humanize }}
    - Component + + Component + {{- end -}} @@ -193,7 +205,17 @@
    Quick Install
    {{ . }}
    - License + {{ if eq . "Commercial" }} + + License + + {{ else }} + + License + + {{ end }} {{- end -}} @@ -204,12 +226,11 @@
    Quick Install
    {{ with .urls.website -}} {{ $websiteHref := printf "href=%q" . | safeHTMLAttr -}} -  Website +  Website {{- end -}} {{ with .urls.docs -}} {{ $docsHref := printf "href=%q" . | safeHTMLAttr -}} -  Documentation +  Documentation {{- end -}} {{ with $package -}} {{ $packageUrl := printf "href=%q" (printf .urlPattern .name) | safeHTMLAttr -}} @@ -230,4 +251,4 @@
    Quick Install
    {{- end -}} -{{ end -}} \ No newline at end of file +{{ end -}} From d430f0270c56cd3d273edf5d8a80a9974323f0e4 Mon Sep 17 00:00:00 2001 From: crocmons Date: Wed, 6 Nov 2024 01:49:12 +0600 Subject: [PATCH 3/7] fixed native issue --- layouts/partials/ecosystem/registry/entry.html | 4 ---- 1 file changed, 4 deletions(-) diff --git a/layouts/partials/ecosystem/registry/entry.html b/layouts/partials/ecosystem/registry/entry.html index c41cf4df4128..79614bac8f87 100644 --- a/layouts/partials/ecosystem/registry/entry.html +++ b/layouts/partials/ecosystem/registry/entry.html @@ -49,10 +49,6 @@ -}} {{ $isNative := and (or (eq .registryType "instrumentation") (eq .registryType "application integration")) (.isNative) }} - - native - {{ $isFirstParty := and (or (eq .registryType "instrumentation") (eq .registryType "application integration")) (.isFirstParty) }} {{ $currentTime := (time now) -}} {{ $delta := $currentTime.Sub (time.AsTime .createdAt) -}} From fe85022d2f5bc92651040fc74f521a7dbefd2ee9 Mon Sep 17 00:00:00 2001 From: crocmons Date: Wed, 6 Nov 2024 01:50:49 +0600 Subject: [PATCH 4/7] fixed native issue --- content-modules/opamp-spec | 2 +- themes/docsy | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/content-modules/opamp-spec b/content-modules/opamp-spec index fb2ff487c70a..950df2967e22 160000 --- a/content-modules/opamp-spec +++ b/content-modules/opamp-spec @@ -1 +1 @@ -Subproject commit fb2ff487c70ac1895652ab5c4a965dfc2ae20d03 +Subproject commit 950df2967e22526aa553aac1d874ac90b973d140 diff --git a/themes/docsy b/themes/docsy index 68aa7b39fc81..cf0c68f041da 160000 --- a/themes/docsy +++ b/themes/docsy @@ -1 +1 @@ -Subproject commit 68aa7b39fc81e2239f3984cacf4c7dc09e7d6b0f +Subproject commit cf0c68f041daac066a0292d521461dbd092d7c31 From f6073b9d1d84ae859bc95fbb7b9a252a2b2a18e7 Mon Sep 17 00:00:00 2001 From: crocmons Date: Wed, 6 Nov 2024 01:59:50 +0600 Subject: [PATCH 5/7] fixed native issue --- content-modules/opamp-spec | 1 - themes/docsy | 1 - 2 files changed, 2 deletions(-) delete mode 160000 content-modules/opamp-spec delete mode 160000 themes/docsy diff --git a/content-modules/opamp-spec b/content-modules/opamp-spec deleted file mode 160000 index 950df2967e22..000000000000 --- a/content-modules/opamp-spec +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 950df2967e22526aa553aac1d874ac90b973d140 diff --git a/themes/docsy b/themes/docsy deleted file mode 160000 index cf0c68f041da..000000000000 --- a/themes/docsy +++ /dev/null @@ -1 +0,0 @@ -Subproject commit cf0c68f041daac066a0292d521461dbd092d7c31 From 7e913647ecf2a57fcf6871db26fcb0c7d62f8ae8 Mon Sep 17 00:00:00 2001 From: crocmons Date: Wed, 6 Nov 2024 02:35:13 +0600 Subject: [PATCH 6/7] Revert "fixed native issue" This reverts commit f6073b9d1d84ae859bc95fbb7b9a252a2b2a18e7. --- content-modules/opamp-spec | 1 + themes/docsy | 1 + 2 files changed, 2 insertions(+) create mode 160000 content-modules/opamp-spec create mode 160000 themes/docsy diff --git a/content-modules/opamp-spec b/content-modules/opamp-spec new file mode 160000 index 000000000000..950df2967e22 --- /dev/null +++ b/content-modules/opamp-spec @@ -0,0 +1 @@ +Subproject commit 950df2967e22526aa553aac1d874ac90b973d140 diff --git a/themes/docsy b/themes/docsy new file mode 160000 index 000000000000..cf0c68f041da --- /dev/null +++ b/themes/docsy @@ -0,0 +1 @@ +Subproject commit cf0c68f041daac066a0292d521461dbd092d7c31 From 17e7574bf74d1ff4dfb6204697d93e82702b4082 Mon Sep 17 00:00:00 2001 From: crocmons Date: Wed, 6 Nov 2024 03:11:37 +0600 Subject: [PATCH 7/7] update new chnges --- content-modules/opamp-spec | 2 +- themes/docsy | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/content-modules/opamp-spec b/content-modules/opamp-spec index 950df2967e22..fb2ff487c70a 160000 --- a/content-modules/opamp-spec +++ b/content-modules/opamp-spec @@ -1 +1 @@ -Subproject commit 950df2967e22526aa553aac1d874ac90b973d140 +Subproject commit fb2ff487c70ac1895652ab5c4a965dfc2ae20d03 diff --git a/themes/docsy b/themes/docsy index cf0c68f041da..68aa7b39fc81 160000 --- a/themes/docsy +++ b/themes/docsy @@ -1 +1 @@ -Subproject commit cf0c68f041daac066a0292d521461dbd092d7c31 +Subproject commit 68aa7b39fc81e2239f3984cacf4c7dc09e7d6b0f