Overview

One of the key aspects of openo11y.dev is to enable people to leverage o11y & how to properly use portions of o11y that relate to the people systems, without those measurements being used for nefarious purposes.

We have internal guidance documentation that needs to be brought over into openo11y.dev.

AC

• document is sanitized & brought over into the site
• a pr is opened for review
• it's reviewed & merged in
• any additional work items are identified for future iterations

Overview

The delivery metrics (leading indicators) are available in the GitHub and GitLab scraper. However, not all metrics included there, are defined in the guidance. We need to update this section to fully encompass the metrics that are being looked at with regards to Git, what they mean, and what you can infer / use them for.

Things to consider:

• recommendation to trunk based development
• measuring your own performance and how to infer from them
• how to measure over time
• include bold statements ( shouldn't use git flow, but if you look holistically maybe that's ok for x repo cuz you're doing the other things right)
• create a decision matrix of example scenarios
• remove run walk crawl & focus on what good looks like
• include external references to DORA metrics, etc.
• code deletion metrics (another area in the github scraper) why deleting code is a good thing

Overview

Update the contributing documentation to ensure that people coming into openo11y from the community are able to get started contributing.

Links may need to be removed or updated.

Overview

Add a CODEOWNERS file to the repository to ensure proper approvals in OS projects.

Overview

Remove the quick start platform section of openo11y until such time we define the work to refine the AWS starting point.

Overview

Update the code coverage section to be more verbose and clear. Code coverage is not a set of absolute truths. There is no number that guarantees quality. It should be made clear on some example of why code coverage can be useful, and where it's not useful.

Things to consider:

• mvps vs production grade (showing quick value vs long term maintenance of a production application)
• 80 % might be ok, 5 % might also be ok
• If all your tests are mocks your code still sucks.

          Agree, this is a tough one to quantify.... Platform Teams ought to subscribe to SLO / SLI's.  Let's table this for a later iteration.

Originally posted by @ericchapman80 in #27 (comment)

Overview

GitHub enables folks to create apps that will essentially send github event data to webhooks.

We can leverage the OTEL webhook receiver for this. Based on previous prototyping, it may be that the webhook receiver needs changes. This would be a great opportunity to contribute improvements to that receiver, or embed functionality within the gitprovider receiver.

Definition of Done

• documentation updated
• collector updated (see o11y platform deployment infrastructure)
• new work defined to tackle improvements & discussion around path forward
• ADR updated based on discussion in projecto11y

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• fix(deps): update dependency mkdocs-material to v9.5.17

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

Overview

Import the updated content from this Google doc and bring into the guidance section.

Ensure meaningful updates are made.

          We think this is a good metric, it just needs a better definition so that it can stand alone and others can contribute.

Originally posted by @ericchapman80 in #27 (comment)

Overview

The navigation should be simple, easy, and completely visible. As of the time of this writing, there is side panel & top navigation. The top navigation doesn't render correctly on mobile, nor inside of backstage.

Recommendation:

• use only the side bar navigation
• include all links on the side bar to ensure that full tree structure is visible & easily reachable

Overview

The intro / summary section of the guidance page should be updated to be more clear and succinct to the audience.

Questions to consider/answer in the summary:

• all this data is subject to interpretation
• who should use this metrics
• how should these metrics be used
• how should you NOT use these metrics (this is not intent for a manager to measure an individuals performance for example - if you want to do this, go away k thx bye 👋 )

Overview

The openo11y welcome page needs to be updated.

The audience has changed, and should be reflected.

Questions to answer:

• Who is this for
• why does it matter
• how do you use openo11y.

Overview

Embed the YouTube demo for DORA and Delivery metrics in the OpenO11y site.

Overview

Update and add delivery metrics pov document that @ericchapman80 created to the project o11y documentation under guidance opinions, delivery metrics.

Acceptance Criteria

• project o11y is updated with this information
• section is created
• basic iteration is done

          Removing this until the next iteration to have better definitions.

Originally posted by @adrielp in #27 (comment)

Overview

The joy metrics section of the guidance is lacking. NPS survey's are also very manual. It'd be good to update this section with some additional context and options, as well as referencing the SPACE metric framework.

Needs a little love

Overview

There needs to be a page on the Liatrio OTEL distribution.

Good examples:

• https://aws.amazon.com/otel/

          This metric probably needs a qualify. Here we're actually measuring the individual. Not every individual will have the same workflow. Time in context does NOT mean time spent in an IDE. I think a better way to measure this is the amount of "scheduled" non-relevant (ie. non-pairing focused) meetings. 

For example: how many useless standups are you having, and how long are they taking. This takes away from time in context.

Originally posted by @adrielp in #27 (comment)

Overview

Create a new page to get started with the o11y demo.

This may require work to rebuild the o11y demo and fork it from open telemetry. This may be done after initial publication of site.