search

CSCfi / csc-user-guide

User guides, FAQs and tutorials related to CSC services
https://docs.csc.fi
Creative Commons Attribution 4.0 International
45 stars 77 forks source link

Python revision #2103

Closed msainio closed 1 week ago

msainio commented 1 month ago

Proposed changes

Move content regarding Python package installations, development environments and parallel jobs from Python application page (apps/python.md) to a new Python usage guide (support/tutorials/python-usage-guide.md). Improve and restructure content.

Rework Python application page. Add content like environment package lists, links to official Python documentation and a warning about using the default system Python 3.6.

Restructure and add content to Jupyter application page.

The most substantial changes introduced in this branch are limited to the following pages:

Checklist before requesting a review

msainio commented 2 weeks ago

Because of an unfortunate git pull --rebase, the commits from 1bd2092 to c050bed are duplicates of earlier commits. Apologies for the mess, and thank you @rkronberg for removing the other branches' commits from the history :)

I added qiskit to the module list on the Python app page. I also reworked the basic content on Jupyter, but I will not update the instructions on modifying the Jupyter Python environment until the new launch form is ready. I will create a new feature branch for that when it is time.

While I still intend to write some instructions and usage examples for running different kinds of Python jobs, I think it is fine to have those in a different feature branch, too, since I do not really plan to modify the content introduced in this branch. I believe the content updates in this branch form a coherent whole, so from my side, this branch is ready for review.

The most substantial changes introduced in this branch are limited to the following pages:

https://csc-guide-preview.rahtiapp.fi/origin/python-revision/apps/jupyter/ https://csc-guide-preview.rahtiapp.fi/origin/python-revision/apps/python/ https://csc-guide-preview.rahtiapp.fi/origin/python-revision/computing/webinterface/jupyter/ (introductory section) https://csc-guide-preview.rahtiapp.fi/origin/python-revision/support/tutorials/python-usage-guide/

rkronberg commented 2 weeks ago

Perhaps adding a what's new for these very nice improvements would be warranted as well? :) https://github.com/CSCfi/csc-user-guide/blob/master/FAQ.md#how-do-i-add-an-entry-to-the-whats-new-section

joonas-somero commented 1 week ago

Another thing I noticed is that there seems to be a number of tab characters, at least in python-usage-guide.md. I'd recommend replacing every tab with four spaces.

msainio commented 1 week ago

Another thing I noticed is that there seems to be a number of tab characters, at least in python-usage-guide.md. I'd recommend replacing every tab with four spaces.

All tabs in python-usage-guide.md and python.md replaced with 4 spaces

joonas-somero commented 1 week ago

@msainio You might want to include WIP in the title or convert to a draft PR if you're still editing. If the required statuses pass, someone may prematurely merge this to master, as a re-review is not required if the branch changes after a passing review. :slightly_smiling_face:

msainio commented 1 week ago

@msainio You might want to include WIP in the title or convert to a draft PR if you're still editing. If the required statuses pass, someone may prematurely merge this to master. 🙂

Oh, I wasn't changing anything important :) I just figured that since all the reviews had been resolved and the PR was still open I would have a quick look if I spotted any wording that could be marginally improved. I.e. I'm not planning to make any further changes to the content.

rkronberg commented 1 week ago

I'll go ahead and merge this then! Brilliant work @msainio and everyone :muscle: