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

Centralize python setup guide #777

Open
WilliamBergamin opened this issue Nov 29, 2022 · 2 comments
Open

Centralize python setup guide #777

WilliamBergamin opened this issue Nov 29, 2022 · 2 comments
Labels
docs Improvements or additions to documentation enhancement New feature or request good first issue
Milestone

Comments

@WilliamBergamin
Copy link
Contributor

Through out the docs and guides we mention how to set up a python project using pyenv, python, venv and pip, it would be nice to centralize this and reference a common resource.

The page URLs

Requirements

Please read the Contributing guidelines and Code of Conduct before creating this issue or pull request. By submitting, you are agreeing to those rules.

@WilliamBergamin WilliamBergamin added docs Improvements or additions to documentation enhancement New feature or request good first issue labels Nov 29, 2022
@seratch
Copy link
Member

seratch commented Nov 30, 2022

I think having a link to a Python setup page instead is not a really great developer experience. If you can have a reusable part for many pages and embed it easily, it would be great.

@seratch seratch added this to the 1.x milestone Nov 30, 2022
@hello-ashleyintech
Copy link

@srtaalej Find virtual env creation throughout the docs (README, maintainer's guide, slack.dev) and find a way to have one standardized approach or source of truth (example areas this appears: https://github.com/slackapi/bolt-python?tab=readme-ov-file#setup and https://github.com/slackapi/bolt-python/blob/main/.github/maintainers_guide.md#python-and-friends and https://slack.dev/bolt-python/tutorial/getting-started#setting-up-your-project and https://slack.dev/bolt-python/tutorial/getting-started-http)

If possible, have some sort of variable or component that dynamically injects the same info - basically try to standardize it across the board. Could find a way to source this globally and inject it - we just want to find a way to reduce redundancy in favor of one standardized approach

Can be an exploratory PR - if one specific source isn't possible, then we can find an alternate approach. @seratch and @WilliamBergamin are good points of contact for this!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation enhancement New feature or request good first issue
Projects
None yet
Development

No branches or pull requests

3 participants