Docs site needs an FAQ section

[yurishkuro]

I was just looking through the open issues in the repo, and many of them are the questions that come again and again either in issues or on gitter, such as "why sampling is not in the spec", etc. Most of those issues have been answered and should really be closed as "wontfix", but closed issues are not a very friendly way for people to learn the answers to these common questions. I think we should start moving them to an FAQ page.

@bensigelman @pritianka

[pritianka-zz]

+1 to FAQ page. I had it in my original spec but we didn't have time to
implement yet. Should I create a google doc for us to put in the content
until there's enough to release an FAQ page?

Priyanka Sharma
Advisor, HeavyBit http://heavybit.com/
Head of Marketing & Partnerships, LightStep http://lightstep.com/
Co-founder, WakaTime http://www.wakatime.com/ - Quantify your coding
www.twitter.com/pritianka
650-796-7125

On Mon, Oct 17, 2016 at 12:08 PM, Yuri Shkuro [email protected]
wrote:

I was just looking through the open issues in the repo, and many of them
are the questions that come again and again either in issues or on gitter,
such as "why sampling is not in the spec", etc. Most of those issues have
been answered and should really be closed as "wontfix", but closed issues
are not a very friendly way for people to learn the answers to these common
questions. I think we should start moving them to an FAQ page.

@bensigelman https://github.com/bensigelman @pritianka
https://github.com/pritianka

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
#134, or mute
the thread
https://github.com/notifications/unsubscribe-auth/ACTTmCPAbUmzEhniMsJb7IStkLlUdZwbks5q08e0gaJpZM4KY_OW
.

[yurishkuro]

Yes, google doc sounds fine. We can even link to it from the site for the time being.

[wu-sheng]

FAQ page will be very helpful. Now I am translating OpenTracing doc to Chinese, many Chinese users are interested, may have so many questions to ask me.

Please keep me notice, if there are any further progress.

[yurishkuro]

@wu-sheng do you want to start adding your question on this ticket? We can decide if they qualify for the FAQ page.

[wu-sheng]

I am very glad to do. Several issues I created are from them.
such as:

1. How should I understand out-of-band and in-band? #155 in-band and out-of band are not easy to understand for them.
2. what should application developer to do, if they want to follow OpenTracing specification.
3. issue [Discuss] Tracer is just interface, is it enough? I think it make users difficult to switch implements. opentracing-java#63, I post on grpc-java

Some other issue, I think they are very beginning, and no need on FAQ page.

And OpenTracing is very new idea for application developers, and framework developers. They need time to take and follow it.

Many of them hope OpenTracing can do something more than a specification or guide, and it can provide a solution to integrate tracer system, APM, framework library and application eco system. All of these part can provide spans, and diff tracer and APM system can collect them , store them, and analysis them, or more.

I am very interesting in development direction of OpenTracing, and want to help OpenTracing to gain influence in China. And if there is the FAQ page, I will continue to translate the page to Chinese, it will be very helpful for Chinese developers.

Is there any opportunities, I can join OpenTracing org or Discussion Group ( or in other ways )? Help me to know the direction earlier, or more fully understand the core goal?

[Shreya1771]

Hi, @pritianka @yurishkuro I would like to work on this issue. :-)
I would Like to know more about what FAQ would contain like.
Thanks!

[tedsuo]

FAQ has been created! :)