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

apm/python: move python documentation links to readthedocs #8598

Merged
merged 3 commits into from
Oct 8, 2020

Conversation

Kyle-Verhoog
Copy link
Member

What does this PR do?

Moves all links from being http://pypi.datadoghq.com/trace/docs to https://ddtrace.readthedocs.io/

Motivation

We're now building versioned docs for the library on readthedocs.

Reviewer checklist

  • Review the changed files.
  • Review the URLs listed in the Preview section.
  • Review any mentions of "Contact Datadog support" for internal support documentation.

@Kyle-Verhoog Kyle-Verhoog added the tracing Content changed in the tracing folder label Sep 21, 2020
@Kyle-Verhoog Kyle-Verhoog requested a review from a team as a code owner September 21, 2020 19:53
Copy link
Contributor

@majorgreys majorgreys left a comment

Choose a reason for hiding this comment

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

A few more replacements for pypi links and references in docs

content/en/tracing/compatibility_requirements/python.md Outdated Show resolved Hide resolved
content/en/tracing/compatibility_requirements/python.md Outdated Show resolved Hide resolved
content/en/tracing/compatibility_requirements/python.md Outdated Show resolved Hide resolved
@@ -21,60 +21,60 @@ La bibliothèque `ddtrace` prend en charge de nombreux frameworks Web, y compris

| Framework | Version prise en charge | Documentation PyPi de Datadog |
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
| Framework | Version prise en charge | Documentation PyPi de Datadog |
| Framework | Version prise en charge | Documentation de Datadog |

| [Molten][8] | >= 0.7.0 | https://ddtrace.readthedocs.io/en/stable/web_integrations.html#molten |
| [Pylons][9] | >= 0.9.6 | https://ddtrace.readthedocs.io/en/stable/web_integrations.html#pylons |
| [Pyramid][10] | >= 1.7 | https://ddtrace.readthedocs.io/en/stable/web_integrations.html#pyramid |
| [Tornado][11] | >= 4.0 | https://ddtrace.readthedocs.io/en/stable/web_integrations.html#tornado |

### Compatibilité des datastores

La bibliothèque `ddtrace` prend en charge les datastores suivants :

| Datastore | Version prise en charge | Documentation PyPi de Datadog |
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
| Datastore | Version prise en charge | Documentation PyPi de Datadog |
| Datastore | Version prise en charge | Documentation de Datadog |

| [Redis][27] [redis-py-cluster][28] | >= 1.3.5 | https://ddtrace.readthedocs.io/en/stable/db_integrations.html#module-ddtrace.contrib.rediscluster |
| [SQLAlchemy][29] | >= 1.0 | https://ddtrace.readthedocs.io/en/stable/db_integrations.html#sqlalchemy |
| [SQLite3][30] | Prise en charge complète | https://ddtrace.readthedocs.io/en/stable/db_integrations.html#sqlite |
| [Vertica][31] | >= 0.6 | https://ddtrace.readthedocs.io/en/stable/db_integrations.html#vertica |

### Compatibilité des bibliothèques

La bibliothèque `ddtrace` prend en charge les bibliothèques suivantes :

| Bibliothèque | Version prise en charge | Documentation PyPi de Datadog |
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
| Bibliothèque | Version prise en charge | Documentation PyPi de Datadog |
| Bibliothèque | Version prise en charge | Documentation de Datadog |

content/fr/tracing/setup/python.md Outdated Show resolved Hide resolved
content/ja/tracing/setup/python.md Outdated Show resolved Hide resolved
Co-authored-by: Tahir H. Butt <tahir.butt@datadoghq.com>
@Kyle-Verhoog
Copy link
Member Author

@majorgreys how do you feel about doing "Library documentation" vs "Datadog documentation". "Datadog documentation" sounds a bit like the corp site docs themselves.

Copy link
Collaborator

@kayayarai kayayarai left a comment

Choose a reason for hiding this comment

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

lgtm from documentation perspective. I agree that the headings should be "Library documentation" not "Datadog documentation." @Kyle-Verhoog Let me know when you commit that change and I'll merge this.

@Kyle-Verhoog
Copy link
Member Author

@kayayarai done! I didn't update it in the fr/jp docs since I think there's a translation process for that. Let me know if this is alright 🙂

Also note that we have #8469 but we can merge these in any order as there will be conflicts either way.

@kayayarai
Copy link
Collaborator

I didn't update it in the fr/jp docs since I think there's a translation process for that. Let me know if this is alright 🙂

That is correct. I'll merge this now.

@kayayarai kayayarai merged commit 143061c into master Oct 8, 2020
@kayayarai kayayarai deleted the kyle/ddtrace-new-url branch October 8, 2020 15:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tracing Content changed in the tracing folder
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants