Skip to content
This repository has been archived by the owner on May 31, 2023. It is now read-only.

Getting started (py) #15

Merged
merged 9 commits into from Feb 13, 2023
Merged

Getting started (py) #15

merged 9 commits into from Feb 13, 2023

Conversation

teh-cmc
Copy link
Member

@teh-cmc teh-cmc commented Feb 9, 2023

  • For Python users
  • For Rust users
  • Getting started with Python

This doesn't cover Getting started with Rust on purpose, let's polish the python one first and then it'll be mostly a job of translating content from one ecosystem to another.

Future technical improvements

  • Incremental code widget to make following the tutorial much easier
  • Better production value for screenshots & GIFs (well, until we have stable Rerun Web)
  • Grab code directly from the main repo during build rather than copy paste
  • "Copy to clipboard" on our source snippets would also be hotness (@jleibs)
  • Other stuff I don't remember right now

@teh-cmc teh-cmc changed the title WIP*10e^99: getting started Getting started: first draft Feb 10, 2023
@teh-cmc teh-cmc marked this pull request as ready for review February 10, 2023 12:06
docs/getting-started/logging-python.md Show resolved Hide resolved
docs/getting-started/logging-python.md Outdated Show resolved Hide resolved
docs/getting-started/logging-python.md Outdated Show resolved Hide resolved
docs/getting-started/logging-python.md Outdated Show resolved Hide resolved
docs/getting-started/logging-python.md Outdated Show resolved Hide resolved
docs/getting-started/logging-python.md Outdated Show resolved Hide resolved
docs/getting-started/logging-python.md Outdated Show resolved Hide resolved
docs/getting-started/logging-python.md Show resolved Hide resolved
docs/getting-started/logging-python.md Outdated Show resolved Hide resolved
docs/getting-started/logging-python.md Show resolved Hide resolved
Copy link
Member

@Wumpf Wumpf left a comment

Choose a reason for hiding this comment

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

OMG this is great!!!

At first I thought it's a bit too conversational, but as a tutorial this is actually super nice; it's not the reference after all

docs/getting-started/logging-python.md Outdated Show resolved Hide resolved
docs/getting-started/python.md Outdated Show resolved Hide resolved
docs/getting-started/python.md Show resolved Hide resolved
docs/getting-started/python.md Outdated Show resolved Hide resolved
docs/getting-started/python.md Outdated Show resolved Hide resolved
docs/getting-started/logging-python.md Outdated Show resolved Hide resolved
docs/getting-started/logging-python.md Outdated Show resolved Hide resolved
docs/getting-started/logging-python.md Outdated Show resolved Hide resolved
docs/getting-started/rust.md Show resolved Hide resolved
docs/getting-started/rust.md Show resolved Hide resolved
@teh-cmc
Copy link
Member Author

teh-cmc commented Feb 11, 2023

Update: there's gonna be some overlap between the "For Python/Rust users" pages and the Python SDK and Rust SDK READMEs, so make sure it's all coherent.

@teh-cmc teh-cmc changed the title Getting started: first draft Getting started (py) Feb 12, 2023
Copy link
Member

@nikolausWest nikolausWest left a comment

Choose a reason for hiding this comment

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

This is really really good! Great job!

Other than my comment on adding some code comments to one section, the only thing I'd change is to use way less exclamation marks "!". It isn't needed and actually doesn't enhance the text.

On the video front I'd very strongly consider just putting them on youtube. I'll help out if you want to go that route.

docs/getting-started/python.md Show resolved Hide resolved
Copy link
Member

@Wumpf Wumpf left a comment

Choose a reason for hiding this comment

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

🚢 ❤️

docs/getting-started/logging-python.md Show resolved Hide resolved
@nikolausWest
Copy link
Member

One more thought: we have support for code switching so we could consider only having a single tutorial where you just toggle code snippets between Rust and Python

@Wumpf
Copy link
Member

Wumpf commented Feb 12, 2023

that would require some reformulating here and there but that would not only look cool but also saves us a lot of work and maintenance!

@teh-cmc
Copy link
Member Author

teh-cmc commented Feb 13, 2023

Yeah we've talked about this already: it will all depend on how different the two tutorials end up looking, which at this point I'm not able to say.

@teh-cmc teh-cmc merged commit a4bd90c into main Feb 13, 2023
@teh-cmc teh-cmc deleted the cmc/getting_started branch February 13, 2023 08:40
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
5 participants