Skip to content

Documentation: Getting started guide and examples overlap #547

Closed
@mauriciovasquezbernal

Description

@mauriciovasquezbernal

From #544 (comment).

There is a lot of overlapping information in the getting started guide and the examples, some of the examples are almost identical in both places making if difficult to maintain and giving no value for the user.

The following table tries to summarize the duplicated logic:

Getting Started Examples
Hello world Basic tracer
Jaeger Exporter Jaeger Exporter
Flask Integration http integration
metrics basic meter *
prometheus prometheus
ot collector ot collector metrics & ot collector tracer

*: the basic meter examples covers the usage of the batch calling convention as the observer instrument.

The only things that are not covered in the getting started guide are the example app and autoinstrumentation.

My proposal would be to get rid of the duplicated examples, keeping only the ones that provides added value (like usage of observer instrument and batch calling convention, also autoinstrumentation).

As an implementation detail, I think it is a good idea to move all the embedded code to proper files and transclude them in the documents, so people that have the source code available don't have to copy & paste all of them.

/cc @toumorokoshi

Metadata

Metadata

Labels

docDocumentation-related

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions