Skip to content
This repository has been archived by the owner on Apr 19, 2021. It is now read-only.

Add Python language guide #376

Merged
merged 31 commits into from
Jan 20, 2020
Merged

Add Python language guide #376

merged 31 commits into from
Jan 20, 2020

Conversation

JesterOrNot
Copy link
Contributor

No description provided.

@JesterOrNot
Copy link
Contributor Author

JesterOrNot commented Jan 4, 2020

@jankeromnes @svenefftinge can you take a look at this

@JesterOrNot JesterOrNot changed the title Add Julia to languages_and_frameworks.md Add Julia to languages_and_frameworks.md and extend python_in_gitpod Jan 5, 2020
Copy link
Contributor

@jankeromnes jankeromnes left a comment

Choose a reason for hiding this comment

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

Hi @JesterOrNot, many many thanks for improving our "Languages & Frameworks" section! You're so fast that it's not easy to keep up. 😅

For this Pull Request, I think you didn't mean to propose all these changes to:

  • src/components/*
  • src/pages/*
  • src/resources/*
  • src/utils/link.tsx

To remove the noise, I will now squash all your commits into one, and only keep the changes to:

  • src/docs/*

I hope that's ok with you. 🙂

@jankeromnes
Copy link
Contributor

Also, please always try to avoid "Merge" commits here. They make the commit history messy (it becomes a mashed-up tree instead of a straightforward linear progression) for no clear benefits.

Note:

  • Using the "Update Pull Request" button on GitHub creates a "Merge" commit (because the developers of GitHub really like them for some reason)
  • Using git rebase upstream/master can clean up any "Merge" commits for you by cleanly "re-basing" your changes on top of the latest upstream commits

Copy link
Contributor

@jankeromnes jankeromnes left a comment

Choose a reason for hiding this comment

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

Thanks a lot for your great work here!

The improvements to the Java page are excellent, many thanks. I'd like to merge them as is.

For the Julia page, it still seems pretty small. If I'm a Julia developer who is new to Gitpod, I'm not sure if this page will really help me configure my own Julia project so that it works well in Gitpod.

I mean sure, looking at the example repositories may give me a clue about what I need to configure, but if I've never seen a Gitpod configuration in my life, or even written a Dockerfile, this may all be too much to deal with (and maybe I'll give up trying to set up Gitpod).

For the Python page, it's pretty cool to have .gitpod.yml and .gitpod.Dockerfile examples, but maybe we don't want to put very long & complicated configurations in front of our new users. So maybe it's better to just cover the basics, e.g. say what exactly you need to do if you want to use wxPython in Gitpod, and then have external links to the full configurations if users want them.

src/docs/julia_in_gitpod.md Outdated Show resolved Hide resolved
src/docs/python_in_gitpod.md Outdated Show resolved Hide resolved
src/docs/python_in_gitpod.md Outdated Show resolved Hide resolved
src/docs/python_in_gitpod.md Outdated Show resolved Hide resolved
src/docs/python_in_gitpod.md Outdated Show resolved Hide resolved
src/docs/python_in_gitpod.md Show resolved Hide resolved
src/docs/python_in_gitpod.md Outdated Show resolved Hide resolved
@jankeromnes
Copy link
Contributor

I took the liberty to split out the Java and Julia guide improvements, which are now merged separately into master.

This PR is actually about the Python guide. Let's update it to reflect that.

@jankeromnes jankeromnes changed the title Add Julia to languages_and_frameworks.md and extend python_in_gitpod Add Python language guide Jan 8, 2020
@jankeromnes jankeromnes changed the title Add Python language guide [docs] Add Python language guide Jan 8, 2020
@JesterOrNot
Copy link
Contributor Author

@jankeromnes can you take another look?

Copy link
Contributor

@jankeromnes jankeromnes left a comment

Choose a reason for hiding this comment

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

Cool post! The wxPython section is starting to look good. However, I feel like there should some content before that section (not all Python developers want to work with wxPython).

Specifically, I think we should mention cool Python example repositories, and any VS Code extensions that could be interesting to install (if there are some that are worth it?)

Here are a few Python example repos from the top of my head:

I don't know about VS Code extensions though.

src/docs/python_in_gitpod.md Outdated Show resolved Hide resolved
src/docs/python_in_gitpod.md Outdated Show resolved Hide resolved
src/docs/python_in_gitpod.md Outdated Show resolved Hide resolved
src/docs/python_in_gitpod.md Outdated Show resolved Hide resolved
src/docs/python_in_gitpod.md Outdated Show resolved Hide resolved
@JesterOrNot
Copy link
Contributor Author

Don't worry on the examples front I have a lot of examples ready to be added!

@JesterOrNot
Copy link
Contributor Author

see #383

@jankeromnes
Copy link
Contributor

jankeromnes commented Jan 10, 2020

The Examples section looks cool! Many thanks.

I feel like it should come before the wxPython section though. Also, very brief descriptions of each example would be cool, e.g.:

  • gitpod-io/django-locallibrary-tutorial: An example website written in Django by MDN
  • JesterOrNot/Gitpod-PyQt: A PyQt example for Gitpod
  • gitpod-io/wxPython-example: A wxPython example for Gitpod
  • techwithtim/Hangman: A simple hangman game made with Python and PyGame

@JesterOrNot
Copy link
Contributor Author

JesterOrNot commented Jan 10, 2020

I'll move it Jan
Done!

@JesterOrNot JesterOrNot changed the title [docs] Add Python language guide [WIP] Add Python language guide Jan 11, 2020
Copy link
Contributor

@jankeromnes jankeromnes left a comment

Choose a reason for hiding this comment

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

Many thanks for the recent fixes! I've added a few more comments / suggestions.

Also, do you know any VS Code extensions that would be useful for Python? (If you don't need any, that's cool too though.)

src/docs/python_in_gitpod.md Outdated Show resolved Hide resolved
src/docs/python_in_gitpod.md Outdated Show resolved Hide resolved
Copy link
Contributor

@jankeromnes jankeromnes left a comment

Choose a reason for hiding this comment

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

Super cool! Thanks a lot for the great work on this guide.

This seems ready to go, except for a minor problem in the Dockerfile. Please fix it, and then we'll be able to "Squash & Merge" all these commits. 👍

src/docs/python_in_gitpod.md Outdated Show resolved Hide resolved
@JesterOrNot
Copy link
Contributor Author

Fixed!

@jankeromnes
Copy link
Contributor

As mentioned on Slack, please open a follow-up PR to mention which Python versions are supported in Gitpod, and how to switch from one to the other (e.g. with a brief pyenv explanation & examples)

@jankeromnes jankeromnes merged commit 79748b7 into gitpod-io:master Jan 20, 2020
@JesterOrNot
Copy link
Contributor Author

So merge this and then open a separate PR?

@JesterOrNot
Copy link
Contributor Author

ok

@jankeromnes
Copy link
Contributor

Many thanks @JesterOrNot! And yes please :)

@JesterOrNot JesterOrNot changed the title [WIP] Add Python language guide Add Python language guide Jan 21, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants