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.

Sign up for GitHub

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

Jump to bottom

WD: Jupyter project #2199

Closed
wants to merge 7 commits into from
Closed

WD: Jupyter project #2199

Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b355663
WD: Jupyter project
rosewms Aug 29, 2024
1510aa3
Merge branch 'main' into wd-jupyter-proj
rosewms Sep 5, 2024
86b48f9
WD edits
rosewms Sep 5, 2024
11063ff
Merge branch 'main' into wd-jupyter-proj
rosewms Sep 6, 2024
a561af1
Merge branch 'main' into wd-jupyter-proj
rosewms Sep 9, 2024
bf402e9
Merge branch 'main' into wd-jupyter-proj
eirinikos Sep 19, 2024
63025db
Merge branch 'main' into wd-jupyter-proj
eirinikos Sep 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/conf/atlantic/2024/writing-day.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,3 +127,17 @@ Project list
------------

Submit your project using our `Writing Day project form <https://forms.gle/uTkWHV3fesyNQEyk9>`_ or send us a PR with your project info!

How far is it to Jupyter? (Session 2)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Join project organizer, Mike O'Neill, during the second session of the day.

Learn how to use `Jupyter <https://jupyter.org/>`__ to be a more effective technical writer. The goal of this Writing Day project is to help you understand how using Jupyter in your tool chain can assist you in creating docs.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Learn how to use `Jupyter <https://jupyter.org/>`__ to be a more effective technical writer. The goal of this Writing Day project is to help you understand how using Jupyter in your tool chain can assist you in creating docs.
Learn how to use `Jupyter <https://jupyter.org/>`__, a web-based interactive development environment for notebooks, code, and data, to be a more effective technical writer. The goal of this Writing Day project is to help you understand how using Jupyter in your tool chain can assist you in creating docs.

Or something similar on what Jupyter actually is, would be good. I pulled this from the website, so it might be the wrong description.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

thanks @mxsasha, I'm hoping the project leader can clarify when I pull him into the review.

Copy link

Choose a reason for hiding this comment

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

I would agree with you because this is what you generally do: write it so that everyone can understand what you are talking about.
Now,

  1. Jupyter is nothing you stumble into. You have to be expert in something to need using it.
  2. among many things 'a web-based'
  3. 'interactive development environment' that is what makes it better than others

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Do you recommend that potential contributors have certain python and SQL packages downloaded before arriving at the event?

If so, @sciustechnologia, can you give me the versions and links to include?


1. What is possible with Jupyter
2. What are the common obstacles
3. Should technical writing include (cost benefit)
4. Critical analysis and recommendations

Check out this `example GitHub repo <Check out this exap>`__.
rosewms marked this conversation as resolved.
Show resolved Hide resolved
Loading