Giter Club home page Giter Club logo

opentelemetry.io's Introduction

OTel logo OpenTelemetry.io

This is the source repository for the OpenTelemetry website, project documentation, and blog. The site is built using Hugo and is hosted on Netlify.

Get involved

To learn how to contribute fixes and new content to this project, read the Contributor's guide, which includes a style guide and useful information on the review process.

If you are new to OpenTelemetry and just get started with it, you are in a perfect position to help us get better: the website and documentation is the entry point for newcomers like you, so if something is unclear or something is missing let us know.

Submit a blog post

For guidance on how to write and submit a blog post, see Submit a blog post.

Add a project to the OpenTelemetry Registry

For details on how to add a project to the OpenTelemetry Registry, see Adding to the registry.

Contributing

We have curated some issues with the tags help wanted and good first issue. This should allow you to quickly find a place to contribute. See CONTRIBUTING.md for more information.

We, the OTel Communications SIG, meet every two weeks on Monday at 10:00 PT. Check out the OpenTelemetry community calendar for the Zoom link and any updates to this schedule.

Meeting notes are available as a public Google doc. If you have trouble accessing the doc, get in touch on Slack.

Here is a list of community roles with current and previous members:

Learn more about roles in the community repository. Thanks to all who have already contributed!

Licenses

opentelemetry.io's People

Contributors

arhell avatar austinlparker avatar avillela avatar brettmc avatar cartermp avatar cartersocha avatar chalin avatar dependabot[bot] avatar dyladan avatar flands avatar gramidt avatar jack-berg avatar jeanbisutti avatar jpkrohling avatar kielek avatar lucperkins avatar mralias avatar mtwo avatar opentelemetrybot avatar pellared avatar reese-lee avatar reyang avatar svrnm avatar theletterf avatar trask avatar tsloughter avatar tylerhelmuth avatar vmihailenco avatar windsonsea avatar wph95 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

opentelemetry.io's Issues

Project status broke?

Looks like the fetch from github failed, so the progress bar and release notes are missing.

Create a back up domain name

See discussion here: #15

We can discuss alternatives:

  • dev
  • net
  • org
  • com

I think dev is cool, but project is not only about developers. So maybe org would be nicer.

Standardize GitHub Milestones for Website

The OpenTelemetry website will be updating shortly (see #30 for more details) with a new feature, an automatically generated SIG progress chart. This chart is generated automatically when the site is published, using data from the GitHub API.

For existing SIGs
In order for each SIG's progress to be accurately reported, each SIG needs to create milestones that match the progress labels in the chart config. Each SIG should create milestones with the following names (note that the label can be a substring of the milestone name):

  • v0.1
  • v0.2
  • v0.3
  • v0.4
  • beta
  • rc
  • v1.0

Once a milestone is completed (by that version releasing), the milestone should be closed.

For new SIGs
If a SIG is being created that wants to add its progress to the chart, the following steps should be taken:

  • In the website repository, make a PR that modifies data/progress_source.yaml and adds a new entry to the data collection in that file.
  • Be sure to follow the format of the other entries exactly - the sourceUrl and label fields are of special note. The sourceUrl should be in the same format (https://github.com/open-telemetry/<repo_name>) as the others. The label field will be used exactly as written as the row label in the chart.

If you find any issues with the chart, please open an issue in the website repository. Maintainers, please use this issue to ask any questions about creating the milestones. Thanks in advance everyone!

Learning Resource Guide

We need a place to collect OSS learning resources (workshop slides, sample apps, etc.) on the page.

Create a content card for OpenTelemetry Tuesdays.

Similar to the card for latest blog content, we should have a card that links to the OpenTelemetry Tuesday streams and archive. In addition, this card should have some visual assets (maybe even a logo for the stream?)

Consider a non-io URL

tl;dr: There are a few significant issues with the .io TLD.

  • Political issues: There are some political concerns around the .io registry that many people feel strongly about. All debate about the actual concerns aside, it seems unnecessary to alienate users and potential users of OpenTelemetry by using a .io URL when we're in a great position to use something else, e.g., opentelemetry.dev.
  • Security: This article explains a vulnerability in which a researcher hijacked nameservers, which would allow rogue redirection
  • Support: As discussed here, it sounds like the registry itself has pretty rough support

Rework the top-level registry page.

The list of items in the registry top-level page isn't great for a couple of reasons:

1: Client-side search is nice but we're pretty limited in what we can easily do through the search templating. You lose the ability to do loops or whatever, for example, like you might in Hugo. Might be a way to tackle this in the JS but I'd need to look at it more, I remember having trouble with it for the original implementation of the registry on opentracing.

2: The card layout doesn't scale well. My druthers is towards something that's more of a list to increase information density.

3: The information architecture is a bit confusing. I think we should generally hew to whatever the main project is going with in terms of order/versioning, so that leaves us with a few basic categories (api, sdk, instrumentation, whatever) and a maturity schema for them (these are in-progress issues). That said, should we consider languages the primary key and roll things up under that, or should we group by type, etc. etc.?

Mostly using this thread to collect ideas/notes on what we should do, we can figure out a plan to do it later down the line.

represent API and production maturity of the many components of OTel

Per open-telemetry/community#290, OTel is a "wide" project with many decoupled components that can and should mature on different schedules. The YAML file in that PR is an attempt to define the "schema" for maturity of both APIs and implementations across OTel.

This issue is a place to discuss how we might represent the maturity matrix on opentelemetry.io. As certain languages reach beta (and others do not), it's vitally important that OTel end-users can easily assess the maturity of the project for their environment, ideally without having to visit individual repos and try to read the tea leaves that way.

Here's an intentionally rough wireframe showing how this could look... of course we'd want a designer to clean this up before implementing, my goal here is just to get feedback about the basic approach:

image

If you're interested in making a counterproposal, feel free to copy-pasta any of the "slides" (sic) in this deck:

https://docs.google.com/presentation/d/1CyBn74KtRMQCMMKLl4ckIfopsdHUL9owVWIGfvMeQSg/edit#slide=id.g6ecdd256ae_0_5

TIA for any feedback!

Website Wishlist!

This is a thread to collect things that we'd like to see done to the website in a more 'big picture' sense.

JavaScript Tracing Documentation

We need to create initial documentation for tracing. It should include -

  • A quick start guide that includes information such as:
    • Initialize/configure the tracer.
    • Create a span, add attributes/events, finish the span.
    • Propagate the trace context to another process over HTTP.
    • Propagate the trace context inside the process.
  • API documentation, or a link to the API documentation if it exists somewhere else.

C# (.NET) Tracing Documentation

We need to create initial documentation for tracing. It should include -

  • A quick start guide that includes information such as:
    • Initialize/configure the tracer.
    • Create a span, add attributes/events, finish the span.
    • Propagate the trace context to another process over HTTP.
    • Propagate the trace context inside the process.
  • API documentation, or a link to the API documentation if it exists somewhere else.

Java Tracing Documentation

We need to create initial documentation for tracing. It should include -

  • A quick start guide that includes information such as:
    • Initialize/configure the tracer.
    • Create a span, add attributes/events, finish the span.
    • Propagate the trace context to another process over HTTP.
    • Propagate the trace context inside the process.
  • API documentation, or a link to the API documentation if it exists somewhere else.

Add .svg logo files to the website for easier access

We should make these available for folks who wish to print their own stickers/swag to make it easier to get.

Ideally both RGB and CMYK versions in full color should be added. I can create the files we need, but not sure if the best bet is to put these on a "brand" page of some kind?

Left nav width is too small

It appears the left nav width is set to 8.3333% for all devices. This is too narrow on desktop. The bulma theme has not been updated in a while so I am not sure if we want to patch or manually adjust.

Golang Tracing Documentation

We need to create initial documentation for tracing. It should include -

  • A quick start guide that includes information such as:
    • Initialize/configure the tracer.
    • Create a span, add attributes/events, finish the span.
    • Propagate the trace context to another process over HTTP.
    • Propagate the trace context inside the process.
  • API documentation, or a link to the API documentation if it exists somewhere else.

Python Tracing Documentation

We need to create initial documentation for tracing. It should include -

  • A quick start guide that includes information such as:
    • Initialize/configure the tracer.
    • Create a span, add attributes/events, finish the span.
    • Propagate the trace context to another process over HTTP.
    • Propagate the trace context inside the process.
  • API documentation, or a link to the API documentation if it exists somewhere else.

Community and Specification content

We will have a fair amount of content in the community and spec repos which we also want to be available directly on the website. This content needs to live in these other repos, due having a different approval process. How should it live in both places? We could copy the changes over to the website by hand, but that feels both brittle and tedious.

Since the content in all three repos is written in markdown, the simplest solution might be to just embed these other repos as submodules, along with a build script that automatically updates them to the latest commit. @lucperkins, having done this song and dance a couple of times now, do you have a preferred approach?

Create an exporter configuration guide for Jaeger

We need a quick start guide for configuring traces to be sent to the Jaeger exporter, which should also include setting up Jaeger (locally, at least?). Basically the idea is "here's what you need to do in order to run Jaeger so you can see traces" as a starting point.

README instructions for running locally don't work

I installed hugo with homebrew, then:

❯ make serve
hugo server \
		--buildDrafts \
		--buildFuture
Building sites … ERROR 2020/02/11 15:42:27 Transformation failed: SCSS processing failed: file "stdin", line 16, col 1: File to import not found or unreadable: bulma/sass/utilities/initial-variables.
Built in 1484 ms
Error: Error building site: logged 1 error(s)
make: *** [serve] Error 255

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.