Skip to content

Initial draft for Python quickstart #6028

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

Merged
merged 15 commits into from
May 7, 2021
Merged

Initial draft for Python quickstart #6028

merged 15 commits into from
May 7, 2021

Conversation

2percentsilk
Copy link
Contributor

Why:

Closes [issue link]

What's being changed:

Adding a quickstart for Python apps in Codespaces to help guide users through adding and updating a devcontainer definition for their Python projects

Check off the following:

Writer impact (This section is for GitHub staff members only):

  • This pull request impacts the contribution experience
    • I have added the 'writer impact' label
    • I have added a description and/or a video demo of the changes below (eg. a "before and after video")

@welcome
Copy link

welcome bot commented May 4, 2021

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label May 4, 2021
2. Update your `devcontainer.json` file after `extensions` to include the following:

```json{:copy}
"forwardPorts": [5000],
Copy link
Contributor

Choose a reason for hiding this comment

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

Is there a reason we're updating the ports here (assuming it's based on the update/rebuild example we used to give in remote-try-python)? Perhaps could provide some context on why you'd want to update this, what it's doing, you don't have to designate ports here because Codespaces takes care of dynamic port forwarding, but you can if you'd like.

In my most recent set of changes to remote-try-python, rather than updating forwardPorts, I guide users through updating portsAttributes.

…rted-with-your-python-project-in-codespaces.md

Co-authored-by: Brigit Murtaugh <brigit.murtaugh@microsoft.com>
2percentsilk and others added 2 commits May 4, 2021 15:38
…rted-with-your-python-project-in-codespaces.md

Co-authored-by: Brigit Murtaugh <brigit.murtaugh@microsoft.com>
…rted-with-your-python-project-in-codespaces.md

Co-authored-by: Brigit Murtaugh <brigit.murtaugh@microsoft.com>
@GeekTrainer
Copy link
Contributor

It generally looks good to me. My primary question is if this is going to be the only intro to Python doc for Codespaces. One of the cool things (to me) is the fact a Flask app like this could run without having to create a Docker container

@timeyoutakeit timeyoutakeit self-requested a review May 4, 2021 23:10
@janiceilene janiceilene added waiting for review Issue/PR is waiting for a writer's review and removed triage Do not begin working on this issue until triaged by the team labels May 4, 2021
@3935849xx

This comment has been minimized.

@3935849xx

This comment has been minimized.

@3935849xx

This comment has been minimized.

@2percentsilk
Copy link
Contributor Author

It generally looks good to me. My primary question is if this is going to be the only intro to Python doc for Codespaces. One of the cool things (to me) is the fact a Flask app like this could run without having to create a Docker container

@GeekTrainer The sample repo I reference will get a readme that has instructions to just open + run without needing to do anything and we'll have that sample repo referenced on our landing page for Codespace docs.

2percentsilk and others added 3 commits May 5, 2021 13:18
…rted-with-your-python-project-in-codespaces.md

Co-authored-by: Christopher Harrison <chrhar@microsoft.com>
@redowll

This comment has been minimized.

@github github deleted a comment from Daytonshaver140 May 6, 2021
timeyoutakeit
timeyoutakeit previously approved these changes May 7, 2021
@timeyoutakeit timeyoutakeit enabled auto-merge May 7, 2021 01:16
@timeyoutakeit timeyoutakeit merged commit 64e4f56 into github:main May 7, 2021
@github-actions
Copy link
Contributor

github-actions bot commented May 7, 2021

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants