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

Propose a more precise tagline #256

Merged
merged 4 commits into from
Apr 9, 2018
Merged

Propose a more precise tagline #256

merged 4 commits into from
Apr 9, 2018

Conversation

bhs
Copy link
Contributor

@bhs bhs commented Apr 2, 2018

This is just one option of many... here's how it looks:

image

Curious what people think. cc @opentracing/otsc since not many people watch this repo.

wu-sheng
wu-sheng previously approved these changes Apr 2, 2018
@codefromthecrypt
Copy link
Contributor

I don't want to back and forth on this, but I'd like to request to take Zipkin off opentracing's homepage. I'd suggest Jaeger instead.

There are a few reasons for this:

  • Jaeger are better staffed and more inclined to want to support people starting with opentracing. OTOH, zipkin are except me unstaffed and being placed here only adds to our burden
  • There's a large amount of confusion about the relationship between OpenTracing and Zipkin, with a fair amount of people thinking Zipkin is an OpenTracing project. Being perpetually on the front page only adds to this.
  • As mentioned in various ways jaeger is "opentracing native" and so it makes a lot more sense for it to be on the home page.

I think this is just a legacy from before jaeger had a docker image. Anyway seems while you are adjusting your website you could consider addressing this.

@JStickler
Copy link

Since OpenTracing is a standard, would it make sense to call that out in the tagline?

"Vendor neutral, standardized APIs for distributed tracing."

@wu-sheng
Copy link
Member

wu-sheng commented Apr 2, 2018

I dont think, exist realy vendor neutral. Stardard group members come from vendors. Even Apache projects can't be considered as vendor neutral. It is just open , welcome and high valued everyone.

@saloni-garg
Copy link

Will the word 'Open-Source' make the tagline more effective?

@wu-sheng
Copy link
Member

wu-sheng commented Apr 2, 2018

Will the word 'Open-Source' make the tagline more effective?

@saloni-garg I think open source is obvious, because OpenTracing hosted in GitHub, and CNCF. Which both required the project open source, especially CNCF asked for Apache 2.0 license.

@wu-sheng
Copy link
Member

wu-sheng commented Apr 2, 2018

+1 about using Jaeger at home page. More opentracing native supported.

@yurishkuro
Copy link
Member

@bhs I think "general purpose" qualifier is so broad that it would invite similar criticism as before. I like the following qualifiers:

  • vendor-neutral (portable is similar, but more vague)
  • standardized (+1 to @JStickler)
  • cross-language / multi-language / polyglot (may not be necessary since we mention 9 langs next)
  • instrumentation APIs, not just APIs (unless we're planning to extend the mission)

@subvocal
Copy link

subvocal commented Apr 2, 2018

+1 to Yuri's suggestion to add the word instrumentation to result in something like:

Portable, general purpose instrumentation APIs for distributed tracing.

@tedsuo
Copy link
Member

tedsuo commented Apr 2, 2018

There is some concern with sing the term "Standard" on the website. Even though it's natural to say "standard tracing API" and "standard tags," the CNCF is not an official standards body. We can say "de-facto standard" or something similar – but it would be best if we avoided the word "Standard" in the main tagline until there is some resolution there.

We do strive for vendor-neutrality, and go to great length to make sure the API works well with all the existing vendors. If it isn't working well for someone then we want to fix it. So that is an intentional goal of the project and I think we should stick with it.

@tedsuo
Copy link
Member

tedsuo commented Apr 2, 2018

Sorry you don't want Zipkin listed @adriancole! But I understand, and we can take it off the marquee. I would still like to list it under "supported tracers" as there are a number of ot-zipkin bridges available to people. Is that all right with you?

@yurishkuro
Copy link
Member

There is some concern with sing the term "Standard" on the website ... the CNCF is not an official standards body.

meh... I wouldn't be hung up on this. When a large group of entities comes up with a "Technical specifications contained in a document that lays characteristics of a product such as levels of quality, performance, safety, or dimensions" (GATT definition), they end up with a standard, whether the group chooses to call itself a "standards body" or not.

Regardless, the current proposal is to use the word "standardized", which is different from "standard".

@AloisReitbauer
Copy link

I was one of people objecting the word standard, because it simply isn't a standard. It might become one, but standards usually have very strict guidelines how they are defined, how implementations are tested, etc.

I would be fine with an "Open Source project aiming to define a standardized API for describing distributed traces".

@codefromthecrypt
Copy link
Contributor

codefromthecrypt commented Apr 3, 2018 via email

@bhs
Copy link
Contributor Author

bhs commented Apr 3, 2018

@adriancole

I'd like to request to take Zipkin off opentracing's homepage

As you wish, sure. I spun this off as #257 since this PR is meant to be about the big-font copy which can/should be clearer.

@bhs
Copy link
Contributor Author

bhs commented Apr 3, 2018

OpenTracing is valuable both for the decoupled "whitebox" application-level instrumentation and – now that the project is further along – the (mostly contributed) instrumentation of 3rd-party OSS out in the wild. As such, I wonder if we should go with something like Vendor-neutral instrumentation and APIs for distributed tracing. Screenshot:

image

As for the debate around the word "standard": with a "lower-case s" that word does not imply – at least to my brain – that OpenTracing is a "standard" in the same way that a centimeter is a standard. I read that word as a synonym for "general-purpose". I removed it in this pass since I don't think the word "standard" is literally necessary and – empirically – it ruffles feathers.

@yurishkuro
Copy link
Member

Vendor-neutral instrumentation and APIs for distributed tracing

+1. Only maybe APIs should come first, "APIs and instrumentation"?

@bhs
Copy link
Contributor Author

bhs commented Apr 3, 2018

@yurishkuro

maybe APIs should come first

I agree... I'm embarrassed to admit this, but I started that way and got annoyed by the line breaks and couldn't figure out where the CSS was to control that particular h1! (It's not well-marked) Anyway, I found it. :)

image

@yurishkuro I've never loved the "vendor" aspect of "vendor-neutral", as most people use OpenTracing with an OSS tracing system (rarely referred to as a "vendor"). But "implementation" feels too wonky. I don't have a better suggestion than "vendor" so I'm ok with this, but if there are other ideas, now's a good time to suggest them.

@AloisReitbauer
Copy link

You can use tool instead of vendor

@bhs
Copy link
Contributor Author

bhs commented Apr 4, 2018

We could say "tool- and vendor-neutral"?

@yurishkuro
Copy link
Member

I think "vendor-neutral" is a well understood & intuitive enough term to not confuse people.

Cf. https://www.gartner.com/it-glossary/vendor-neutral

@bhs
Copy link
Contributor Author

bhs commented Apr 4, 2018

@yurishkuro I slept on it and agree that adding the "tool-" terminology doesn't make it clearer.

I also updated the css a bit for various reasons and fixed an issue with "medium" screen sizes while I was in the area.

image

Copy link
Member

@yurishkuro yurishkuro left a comment

Choose a reason for hiding this comment

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

lgtm

@codefromthecrypt
Copy link
Contributor

I added #258 and waiting for others in openzipkin who have burden supporting tracers agree that zipkin should be removed entirely. It isn't up to people who don't contribute to make this decision

Copy link
Member

@wu-sheng wu-sheng left a comment

Choose a reason for hiding this comment

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

Didn't support Vendor neutral in any projects. So, change my approved to just comment only.

@wu-sheng wu-sheng dismissed their stale review April 5, 2018 00:07

-0 only

@bhs
Copy link
Contributor Author

bhs commented Apr 6, 2018

This PR doesn't seem to be generating new opinions. I think what's here is a net improvement for sure... the one phrase that's both (a) still present and (b) somewhat problematic is "vendor-neutral"... I have done a bunch of googling and see that term used for numerous efforts where "vendors" (sic) are often OSS. As such, I think the usage here is still idiomatic (as Yuri pointed out above).

I'd like to merge this before Monday AM if there are no strong objections.

@bhs bhs merged commit ba63ed8 into master Apr 9, 2018
@bhs bhs deleted the bhs/tagline branch April 9, 2018 05:01
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.

9 participants