From b3556631f078e0460980f3422ac5ffd1e71c4920 Mon Sep 17 00:00:00 2001 From: Rose Williams Date: Wed, 28 Aug 2024 21:52:21 -0400 Subject: [PATCH 1/2] WD: Jupyter project --- docs/conf/atlantic/2024/writing-day.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/conf/atlantic/2024/writing-day.rst b/docs/conf/atlantic/2024/writing-day.rst index 726dbf839..fb28ab402 100644 --- a/docs/conf/atlantic/2024/writing-day.rst +++ b/docs/conf/atlantic/2024/writing-day.rst @@ -127,3 +127,17 @@ Project list ------------ Submit your project using our `Writing Day project form `_ 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 `__ 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. + +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 `__. From 86b48f97249646162bb3657f9d864f86e73b1a49 Mon Sep 17 00:00:00 2001 From: Rose Williams Date: Thu, 5 Sep 2024 15:14:11 -0400 Subject: [PATCH 2/2] WD edits --- docs/conf/atlantic/2024/writing-day.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/conf/atlantic/2024/writing-day.rst b/docs/conf/atlantic/2024/writing-day.rst index fb28ab402..17c35130c 100644 --- a/docs/conf/atlantic/2024/writing-day.rst +++ b/docs/conf/atlantic/2024/writing-day.rst @@ -133,11 +133,13 @@ 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 `__ 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. +Note, this project was designed with more experienced documentarians, those who focus on technical and developer documentation. This project is a great opportunity for attendees with a software development, or similar, background. + +Learn how to use `Jupyter `__, 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's interactive development environment and how it can assist you in creating docs. 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 `example GitHub repo `__.