Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Major rework of ecosystem pages #3060

Merged
merged 10 commits into from
Jul 26, 2023
Merged

Conversation

svrnm
Copy link
Member

@svrnm svrnm commented Jul 21, 2023

This PR addresses some of the things we discussed in #2178, #2238, #1701

Note, that I made a lot of decisions along the way, so don't hesitate to call out anything you dislike on how I have changed things.

Here are a few pointers:

  • All three pages (vendors, adopters, integrations) are data-driven. I am not yet 100% satisfied with the format, but I think it's a starting point
  • There are short codes to render tables from those.
  • I updated the vendors table to also mention if there are open source offerings or if the offering is maybe even purely OSS (jaeger, skywalking, etc.), it makes the name "vendor" a little bit odd, but I think we can discuss this
  • The vendors are now listed pure-oss-first, oss&commercial second, only commercial last and then alphabetical within, I felt that this is the best order as it highlights OSS offerings
  • I added a footnote to every page what is required to be added to the list. As you maybe can see they are stricter than before (provide a contact, provide proof for everything). I also added a note that exempts existing entries until Jan 1th next year.
  • For "adopters" and "vendors" there should be a contact, as they mostly come from those organisations. For integrations I did not add this requirement as they have been added by ppl from the otel community.
  • I removed the "within opentelemetry" integrations list, I found that one really odd, as it just lists some projects but gives no indication how those are integrated (my assumption is that for all of these there are collector exporters/receivers or maybe language specific exporters/receivers, this is represented through the registry)
  • After we have this in place I can crawl previous PRs to find existing contacts for adopters & vendors, such that we can alert them to review their entries.

Preview:

@svrnm svrnm requested a review from a team July 21, 2023 15:05
@cartermp
Copy link
Contributor

I really like the changes overall. I think the vendors table needs some CSS work to widen it, though. Compare what's changed here:

image

With what's live:

image

@cartermp
Copy link
Contributor

Hmmm, I guess now that I lay it out it's not that much worse. Eh, let's deal with that later.

Copy link
Contributor

@cartermp cartermp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Love the changes overall.

@cartermp
Copy link
Contributor

Would also like @chalin to pipe in here, but otherwise I think this one's good.

@chalin
Copy link
Contributor

chalin commented Jul 24, 2023

Would also like @chalin to pipe in here, but otherwise I think this one's good.

Taking a look now (just back).

Copy link
Contributor

@chalin chalin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, very nice improvements; thanks @svrnm! 🎉

I focused on copyedits for the prose in this round of reviews. See inline comments.

(Later I might have some suggested improvements and simplifications to offer for the shortcodes, but they could land as is for now too.)

content/en/ecosystem/adopters.md Outdated Show resolved Hide resolved
content/en/ecosystem/adopters.md Outdated Show resolved Hide resolved
content/en/ecosystem/adopters.md Outdated Show resolved Hide resolved
content/en/ecosystem/adopters.md Outdated Show resolved Hide resolved
content/en/ecosystem/adopters.md Outdated Show resolved Hide resolved
content/en/ecosystem/integrations.md Outdated Show resolved Hide resolved
content/en/ecosystem/vendors.md Outdated Show resolved Hide resolved
content/en/ecosystem/vendors.md Outdated Show resolved Hide resolved
content/en/ecosystem/vendors.md Outdated Show resolved Hide resolved
content/en/ecosystem/vendors.md Outdated Show resolved Hide resolved
@svrnm
Copy link
Member Author

svrnm commented Jul 25, 2023

thanks @chalin , I applied all the suggestions you made

@chalin chalin force-pushed the update-ecosystem branch from 0671aa5 to 736c19e Compare July 25, 2023 15:39
Copy link
Contributor

@chalin chalin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Getting there! I made another pass of copyediting. PTAL

content/en/ecosystem/integrations.md Outdated Show resolved Hide resolved
content/en/ecosystem/integrations.md Outdated Show resolved Hide resolved
content/en/ecosystem/integrations.md Outdated Show resolved Hide resolved
content/en/ecosystem/integrations.md Outdated Show resolved Hide resolved
content/en/ecosystem/vendors.md Outdated Show resolved Hide resolved
content/en/ecosystem/vendors.md Outdated Show resolved Hide resolved
content/en/ecosystem/vendors.md Outdated Show resolved Hide resolved
@svrnm
Copy link
Member Author

svrnm commented Jul 26, 2023

Getting there! I made another pass of copyediting. PTAL

thanks once again, all suggestions have been applied

Copy link
Contributor

@chalin chalin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @svrnm.

Maybe try the /fix:* commands (for fix:format and fix:refcache) to see if they work?

@svrnm
Copy link
Member Author

svrnm commented Jul 26, 2023

/fix:*

@svrnm
Copy link
Member Author

svrnm commented Jul 26, 2023

@chalin
Copy link
Contributor

chalin commented Jul 26, 2023

Sorry if I wasn't clear: I meant to try each command separately. We don't have /fix:* enabled yet -- I used that syntax to avoid triggering the scripts :)

@chalin
Copy link
Contributor

chalin commented Jul 26, 2023

All green, merging!

@chalin chalin merged commit e9d96b4 into open-telemetry:main Jul 26, 2023
@svrnm
Copy link
Member Author

svrnm commented Jul 26, 2023

🎉

@svrnm svrnm deleted the update-ecosystem branch July 26, 2023 16:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants