Is your feature request related to a problem?
It is not a problem but the documentation of the contribution file gave me some problems in understanding the rules that were proposed.
The links used in the contributing.md file had inconsistencies, for example some links were permalinks and others were not.
For cases where a specific line of code is referenced, it is always recommended to use permalinks, this gives us the possibility of having the part of code that we referred to at the exact moment of putting together the documentation.
Below I show you some examples of links that were wrong:
I change
|
if context.get_value("suppress_instrumentation") or context.get_value( |
For
|
with _suppress_instrumentation(_SUPPRESS_INSTRUMENTATION_KEY): |
Because the implementation of suppress_instrumentation has been changed
I change
|
if not _excluded_urls.url_disabled(flask.request.url): |
For
|
or not excluded_urls.url_disabled(flask.request.url) |
Describe the solution you'd like
To amend this, the links should be replaced with permalinks where they refer to a line of code, while the links that refer to files or external content should be left as a link.
Additionally, you should follow the rules that markdown proposes for your md files (I found several style rules that were not followed), a good guide is to use some markdownlint.
Some of the rules that are not followed:
Additional context
Some useful links:
https://www.markdownguide.org/basic-syntax/
https://github.com/orgs/community/discussions/35615#discussioncomment-3834745
Is your feature request related to a problem?
It is not a problem but the documentation of the contribution file gave me some problems in understanding the rules that were proposed.
The links used in the contributing.md file had inconsistencies, for example some links were permalinks and others were not.
For cases where a specific line of code is referenced, it is always recommended to use permalinks, this gives us the possibility of having the part of code that we referred to at the exact moment of putting together the documentation.
Below I show you some examples of links that were wrong:
I change
opentelemetry-python-contrib/instrumentation/opentelemetry-instrumentation-requests/src/opentelemetry/instrumentation/requests/__init__.py
Line 111 in 3ec7736
For
opentelemetry-python-contrib/opentelemetry-instrumentation/src/opentelemetry/instrumentation/utils.py
Line 191 in 2518a4a
Because the implementation of suppress_instrumentation has been changed
I change
opentelemetry-python-contrib/instrumentation/opentelemetry-instrumentation-flask/src/opentelemetry/instrumentation/flask/__init__.py
Line 91 in 0fcb60d
For
opentelemetry-python-contrib/instrumentation/opentelemetry-instrumentation-flask/src/opentelemetry/instrumentation/flask/__init__.py
Line 327 in 2518a4a
Describe the solution you'd like
To amend this, the links should be replaced with permalinks where they refer to a line of code, while the links that refer to files or external content should be left as a link.
Additionally, you should follow the rules that markdown proposes for your md files (I found several style rules that were not followed), a good guide is to use some markdownlint.
Some of the rules that are not followed:
Additional context
Some useful links:
https://www.markdownguide.org/basic-syntax/
https://github.com/orgs/community/discussions/35615#discussioncomment-3834745