sentry-docs icon indicating copy to clipboard operation
sentry-docs copied to clipboard

Docs for PyMongo integration

Open Agalin opened this issue 3 years ago • 8 comments

  • Added guide for PyMongo
  • Added wizard for PyMongo

Docs for getsentry/sentry-python/#1590

TBH I wasn't able to test this change, setting up docs build environment is harder than implementing PyMongo integration in Python SDK. 😓 Python 2 is no longer part of the macOS and I'd rather avoid installing it on my machine while it's required due to ancient node-gyp version. Latest node container also fails after installing Python 2.7 on hard to debug C code.

Legal Boilerplate

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

Agalin avatar Aug 31 '22 13:08 Agalin

Someone is attempting to deploy a commit to the Sentry Team on Vercel.

A member of the Team first needs to authorize it.

vercel[bot] avatar Aug 31 '22 13:08 vercel[bot]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
sentry-docs ✅ Ready (Inspect) Visit Preview Sep 6, 2022 at 2:59PM (UTC)

vercel[bot] avatar Aug 31 '22 15:08 vercel[bot]

Thanks. I've also noticed a few inconsistencies in PyMongo capitalization, changed all to the one used by its docs (uppercase P and M).

Agalin avatar Sep 02 '22 08:09 Agalin

One more thing. Just realised that list of integrations on the right is provided for "frameworks" according to the main python page. Should PyMongo docs instead be placed to Configuration -> Integrations section? Redis and SQLAlchemy are there - but so is Flask which should rather be considered a framework.

Agalin avatar Sep 02 '22 11:09 Agalin

One more thing. Just realised that list of integrations on the right is provided for "frameworks" according to the main python page. Should PyMongo docs instead be placed to Configuration -> Integrations section? Redis and SQLAlchemy are there - but so is Flask which should rather be considered a framework.

@getsentry/team-web-sdk-backend - You'll need to answer this.

imatwawana avatar Sep 06 '22 14:09 imatwawana

This pull request has gone three weeks without activity. In another week, I will close it.

But! If you comment or otherwise update it, I will reset the clock, and if you label it Status: Backlog or Status: In Progress, I will leave it alone ... forever!


"A weed is but an unloved flower." ― Ella Wheeler Wilcox 🥀

github-actions[bot] avatar Oct 04 '22 00:10 github-actions[bot]

Well. Still waiting for decision on docs placement but it doesn't matter as long as integration itself is not reviewed.

Agalin avatar Oct 04 '22 07:10 Agalin

sorry @Agalin, we'll try to fit this in soon, too much going on.

sl0thentr0py avatar Oct 05 '22 14:10 sl0thentr0py

One more thing. Just realised that list of integrations on the right is provided for "frameworks" according to the main python page. Should PyMongo docs instead be placed to Configuration -> Integrations section? Redis and SQLAlchemy are there - but so is Flask which should rather be considered a framework.

Imo the guides are a good place. (If you are interested: There is currently a discussion going on about maybe changing the location of some parts of the documentation, but because we have a lot of different languages/platforms that work in different ways this can be a longer endeavor: https://github.com/getsentry/sentry-docs/issues/5669 )

antonpirker avatar Nov 04 '22 10:11 antonpirker

I have added a screenshot and moved some parts a bit around in your PR, could you merge this in please: https://github.com/operasoftware/sentry-docs/pull/1 @Agalin ?

antonpirker avatar Nov 04 '22 10:11 antonpirker

Added a few minor comments to that one. Keep in mind I still need to update those docs with results of the discussion here (notably about motor).

Agalin avatar Nov 04 '22 11:11 Agalin

I have now made the changes @Agalin Now my branch is correct with motor, right?

antonpirker avatar Nov 04 '22 15:11 antonpirker

You've merged my latest changes so yeah, it's fine. There is one small discussion left in that pull request.

Agalin avatar Nov 04 '22 15:11 Agalin

So now this PR is ready for release. After the Python SDK was released, I will merge this.

antonpirker avatar Nov 07 '22 08:11 antonpirker