Status page - make it a hub for language SDKs, spec, collector, etc.

[cartermp]

This was discussed in the 7/28/22 SIG meeting.

Today, the status page is actually the specification status page. However, whenever we talk to end-users, this is not the primary thing that comes to mind when they want to know the "status" of something. Most of the time, they actually want to know if a given signal (e.g., metrics) is stable/alpha/beta in the language that they need to use. Spec and collector status do come up, but not as often.

Thus, there's a desire to rework this page so that we can link out to constituent statuses for different things:

• Language SDKs (each has a status section in the docs)
• Spec (we already have this page)
• Collector (a section and/or page would have to be created)

Very rough wireframe mocking up the idea:

The idea is that you can click a box/logo that takes you to the status for that thing.

This issue is a part of:

• Status page rework 22Q3 #1574

[melbgirl]

I can take this one, I have some time later this week. Can someone point me to any exiting style elements (eg cards) ?

[chalin]

Thanks @melbgirl - note that there's some preparatory work to be done first (see the meeting notes) for a proposed "update plan". I can give more details later, gotta rush to a meeting now.

[cartermp]

Also FWIW the iconography is at least all standard and usable: https://github.com/open-telemetry/opentelemetry.io/tree/main/iconography/512x512

[chalin]

Oops, sorry Libby, I was rushing to my next meeting and didn't realize that @melbgirl was your ID! So of course you know about the proposed update plan 🤷‍♂️.

[TylerHelmuth]

For the collector, are users asking for the status of the collector as a whole or individual components within the collector (otlpexporter, hostmetricsreceiver, etc)? I have encountered both on the slack channel.

[cartermp]

@TylerHelmuth That's a good question. I've personally only fielded questions about the collector as a whole, and why some components aren't a part of the contrib distribution. Not necessarily about if a given component is stable. But I imagine that will come up sooner than later.

I think that in docs, we could probably do two things:

1. State the status of the collector itself
2. Make mention that components in the contrib distribution are of mixed maturity, and a maturity model may (will?) be established to better distinguish which are stable and which are not

Thoughts?

[TylerHelmuth]

Makes sense. The collector SIG has established Stability Levels for components and is working towards getting all component READMEs updated with that status (and more). There has also been updates to allow components to print out their stability level on collector startup if the component is unmaintained or deprecated. Hopefully that work is helpful in some way.

[chalin]

FYI: keeping this issue for the status-page-as-hub feature, I've created #1574 to track all of the Status page rework that was agreed to during the Comms/Website meeting.

[chalin]

@TylerHelmuth et all: FYI, here's the collector-specific issue:

• Add Collector status to the collector page #1573

[melbgirl]

@chalin and @cartermp: I was thinking to use images as the 'boxes' in the design, rather than using an HTML table. What are your thoughts?

[cartermp]

I'd defer to @chalin on if that fits the overall technical goals for the repo, but I'm quite fine with that as an approach.

[chalin]

... rather than using an HTML table

We'll want a flex design that caters to viewing on mobile as well as desktop -- so not a table. As a first cut for the page design, I'd vote to use plain text (rather than images) either as a simple link or a button-role (rather than a card). That is, IMHO, we should aim to get a functional page first with the proper flex design (for mobile and desktop), then beautify it later. (But if you want to do it all in one go, that ok too :).

[melbgirl]

How do we think the page transformation is going? Are there other things we'd like to see, or can we consider this item complete?

[cartermp]

I'm happy with how it's looking right now. Always ways to improve, but it's got all the necessary information on it today. Let's close this out and if there's more enhancements people want to do, we can just create PRs and/or issues. Thanks, @melbgirl!

[melbgirl]

No worries Patrice, all good👍

…

On Jul 28, 2022, at 1:01 PM, Patrice Chalin ***@***.***> wrote:  Oops, sorry Libby, I was rushing to my next meeting and didn't realize that @melbgirl was your ID! So of course you know about the proposed update plan 🤷‍♂️. — Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you were mentioned.