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

WD: Jupyter project #2199

Closed
wants to merge 7 commits into from
Closed

WD: Jupyter project #2199

wants to merge 7 commits into from

Conversation

rosewms
Copy link
Collaborator

@rosewms rosewms commented Aug 29, 2024

Atlantic 2024 Writing Day project.

  • Staff review to confirm project is suited for Writing Day
  • WD project lead/organizer review to ensure project is described properly
  • Final review before publishing

📚 Documentation preview 📚: https://writethedocs-www--2199.org.readthedocs.build/

Copy link
Contributor

@plaindocs plaindocs left a comment

Choose a reason for hiding this comment

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

Seems fine. Maybe highlight a little more that this isn't a collaborative writing thing per se

Copy link
Contributor

@mxsasha mxsasha left a comment

Choose a reason for hiding this comment

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

Minor notes inline. Link will need to be fixed :)

docs/conf/atlantic/2024/writing-day.rst Outdated Show resolved Hide resolved

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.

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?

@eirinikos
Copy link
Member

Closing this PR, since we've been notified that our project organizer is unable to host a WD session this time.

@sciustechnologia good luck with everything, please feel free to submit a WD project the next time you're able to 🙇

@eirinikos eirinikos closed this Sep 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants