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

Python docs #446

Closed
wants to merge 37 commits into from
Closed

Python docs #446

wants to merge 37 commits into from

Conversation

gvdongen
Copy link
Contributor

@gvdongen gvdongen commented Aug 28, 2024

  • Add SDK reference documentation for Python

Still to do in follow-up PRs: Quickstart, concept pages

Copy link

cloudflare-workers-and-pages bot commented Aug 28, 2024

Deploying documentation with  Cloudflare Pages  Cloudflare Pages

Latest commit: 7d799ed
Status: ✅  Deploy successful!
Preview URL: https://2ac7b843.documentation-beg.pages.dev
Branch Preview URL: https://python-docs.documentation-beg.pages.dev

View logs

@gvdongen gvdongen changed the base branch from python_tour to main August 28, 2024 09:32
@gvdongen gvdongen marked this pull request as ready for review August 28, 2024 09:32
@gvdongen gvdongen changed the base branch from main to python_tour August 28, 2024 10:15
You can run them as follows:

```shell
python -m hypercorn --config hypercorn-config.toml -b localhost:9080 example:app
Copy link
Contributor

Choose a reason for hiding this comment

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

Same comment as #447 (comment), i don't think you need to specify the bind address here

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think it's better to do so though since all our docs are written with the assumption that the service runs on 9080... Otherwise users will just have to look that up. I think it makes the experience just a bit more fluent.

Copy link
Contributor

@slinkydeveloper slinkydeveloper Aug 29, 2024

Choose a reason for hiding this comment

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

then how about you remove the hypercorn config? at least in the quickstart, it adds some noise that is not needed.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Or can we add it to the hypercorn config? Then we can remove it from the other commands

Copy link
Contributor

Choose a reason for hiding this comment

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

But the bind address is in the hypercorn config: https://github.com/restatedev/examples/blob/main/templates/python/hypercorn-config.toml#L1 that's why specifying that -b is redundant

Base automatically changed from python_tour to main September 9, 2024 14:29
@gvdongen gvdongen closed this Sep 9, 2024
@gvdongen gvdongen deleted the python_docs branch September 9, 2024 15:07
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