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

Adding Python docs to new template update #558

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

nikomancy
Copy link
Contributor

What?

Updating the Python docs to follow the same multipage pattern as our Javascript docs.

Why?

  • The goal is to make the learning journey for engineers working with specific SDKs easier.
  • Content is easier to find in the TOC, improving navigability.
  • Code samples for typed assignment examples have been added for ease of use.
  • Boilerplate prose docs have been added to allow engineers to learn about relevant conceptual information alongside the code without having to context switch to other parts of the docs.

Review instructions

  • Let's discuss the Python SDK 4.0 announcement doc. Are there any places in the docs where the differences between 3.0 and 4.0 are different enough that we need to preserve older doc information? Are we safe to get rid of that page?
  • Please make sure the code samples are accurate.

Todo before merge

  • Delete python.md
  • Delete announcing-python-4-0.md
  • Update redirects

@nikomancy nikomancy requested a review from aarsilv December 19, 2024 21:53
Copy link

netlify bot commented Dec 19, 2024

Deploy Preview for eppo-data-docs ready!

Name Link
🔨 Latest commit e07e8ec
🔍 Latest deploy log https://app.netlify.com/sites/eppo-data-docs/deploys/676495f7f1fd910008ae6302
😎 Deploy Preview https://deploy-preview-558--eppo-data-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@lukasgoetzweiss
Copy link
Contributor

It looks like this PR drops some of the examples that are currently live. Can we add a page including those? This is a great example of where having a whole python section can help us add dedicated pages for common use cases: batch process jobs, django apps, etc.

Also, can we update this PR to include this feedback from Slack?

@rasendubi rasendubi mentioned this pull request Jan 6, 2025
Copy link
Collaborator

@rasendubi rasendubi left a comment

Choose a reason for hiding this comment

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

Review: #561

One of the diffs between pre/post 4.0 is that 4.0 exposes all things from eppo_client directly, whereas pre-4.0 exported things from somewhat random places. (Old locations are still supported but depricated.)

@rasendubi rasendubi assigned nikomancy and unassigned rasendubi Jan 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants