Claudiaregio/jupyter read me #430

claudiaregio · 2020-11-10T01:10:28Z

Thinking about removing feature details section because of their heavy tie to Python, looking for feedback.

README.md

Co-authored-by: Joyce Er <[email protected]>

DonJayamanne

I don't agree with the title. 99% of users would want to use interactive window and old notebooks. Going into market place gives them the false impression that this extension works only in insisted as the title suggests.
When extensions are blogged about a screenshot of readme page is used and this will add to this confusion.

I would instead add a separate section just for native notebooks, which happens to be only a feature of this extension, and indicate the requirements in that section.

IanMatthewHuff · 2020-11-10T16:28:31Z

README.md


-## Set up your environment
+-   **Step 2.** Install the [Jupyter Extension](https://code.visualstudio.com/docs/python/python-tutorial#_prerequisites) in VS Code Insiders - CHANGE ME


Is CHANGE ME a todo here? Just waiting for the link?

Yes just waiting for the marketplace extension link here

README.md

IanMatthewHuff · 2020-11-10T16:33:09Z

README.md

-<!-- use less words -->
+-   **Step 2.1** If you are interested in using Python, we recommend you install the [Python Extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) instead.
+-   **Step 3.** If not working with Python, make sure you have a kernel specification that corresponds to the language you would like to use installed on Jupyter on your machine.
+-   **Step 4.** Open or create a notebook file and start coding!


Mentioning the command to create a new blank notebook might be helpful here. We've seen users confused by this before and they can't just create a new empty one like a .py file.

Ahh, you mention that just below, probably not needed here then.

IanMatthewHuff · 2020-11-10T16:35:31Z

README.md

-   Select your Python interpreter by clicking on the status bar
-
-     <img src=https://raw.githubusercontent.com/microsoft/vscode-jupyter/main/images/InterpreterSelectionZoom.gif width=280 height=100>
+## Set up your environment


This section header name doesn't really seem to apply anymore. Getting started? Starting a notebook? Running a notebook? Not fully sure on the best name.

IanMatthewHuff · 2020-11-10T16:35:40Z

README.md


-   Configure the debugger through the Debug Activity Bar
+<!-- use less words -->


Another todo here?

IanMatthewHuff · 2020-11-10T16:37:35Z

README.md


-   Configure tests by running the `Configure Tests` command
+     <img src=https://raw.githubusercontent.com/microsoft/vscode-jupyter/main/images/Jupyter%20README/CreateNewNotebook.png>


The old GIFs specifically set width and height. I would think that's probably to have them aligned correctly. Do these look ok if you shrink / expand the window size?

Edited: The default sizes came from the Python read me, I need to see how these render before changing the sizes back.

README.md

IanMatthewHuff · 2020-11-10T16:47:30Z

README.md


-To see all available Python commands, open the Command Palette and type `Python`.
+To see all available Jupyter Notebook commands, open the Command Palette and type `Jupyter` or `Notebook`.

 ## Feature details

 Learn more about the rich features of the Jupyter extension:

 -   [IntelliSense](https://code.visualstudio.com/docs/python/editing#_autocomplete-and-intellisense): Edit your code with auto-completion, code navigation, syntax checking and more


Little bit unsure of how we list this support. We do support this for Python with the extension installed, and in a limited fashion for other languages. But we certainly don't have something like code navigation for Julia or other languages. Same thing with our listing of debugging support.

README.md

IanMatthewHuff

There were a few changes that I think we need here. Probably of biggest importance was that we're now advertising as a multi-language extension, but we still have lots of features listed in the debugging / formatting / intellisense sections that we don't directly provide and are only available for Python + the Python Extension.

IanMatthewHuff

Changes look good to me. GIFs don't have the sizing, but not sure if that is actually an issue or not.

…soft/vscode-jupyter into claudiaregio/jupyterReadMe

* remove refactoring from description * Updated Jupyter ReadMe * Update README.md Co-authored-by: Joyce Er <[email protected]> * Update README.md Co-authored-by: Joyce Er <[email protected]> * Update README.md Co-authored-by: Joyce Er <[email protected]> * Edit step 3 in setup * Jupyter ReadMe 2 * plz let this be the last jupyter readme update * updated jupyter extension marketplace link Co-authored-by: Joyce Er <[email protected]>

* Claudiaregio/jupyter read me (#430) * remove refactoring from description * Updated Jupyter ReadMe * Update README.md Co-authored-by: Joyce Er <[email protected]> * Update README.md Co-authored-by: Joyce Er <[email protected]> * Update README.md Co-authored-by: Joyce Er <[email protected]> * Edit step 3 in setup * Jupyter ReadMe 2 * plz let this be the last jupyter readme update * updated jupyter extension marketplace link Co-authored-by: Joyce Er <[email protected]> * Final update for release Co-authored-by: claudiaregio <[email protected]> Co-authored-by: Joyce Er <[email protected]>

* Claudiaregio/jupyter read me (#430) * remove refactoring from description * Updated Jupyter ReadMe * Update README.md Co-authored-by: Joyce Er <[email protected]> * Update README.md Co-authored-by: Joyce Er <[email protected]> * Update README.md Co-authored-by: Joyce Er <[email protected]> * Edit step 3 in setup * Jupyter ReadMe 2 * plz let this be the last jupyter readme update * updated jupyter extension marketplace link Co-authored-by: Joyce Er <[email protected]> * Add new license for extension Co-authored-by: claudiaregio <[email protected]> Co-authored-by: Joyce Er <[email protected]>

claudiaregio added 2 commits November 5, 2020 17:00

remove refactoring from description

1685ef0

Updated Jupyter ReadMe

05074ec

claudiaregio requested a review from a team as a code owner November 10, 2020 01:10

claudiaregio requested a review from ronglums November 10, 2020 01:11

rchiodo reviewed Nov 10, 2020

View reviewed changes

README.md Outdated Show resolved Hide resolved

rchiodo approved these changes Nov 10, 2020

View reviewed changes

joyceerhl reviewed Nov 10, 2020

View reviewed changes

README.md Outdated Show resolved Hide resolved

joyceerhl reviewed Nov 10, 2020

View reviewed changes

README.md Outdated Show resolved Hide resolved

joyceerhl reviewed Nov 10, 2020

View reviewed changes

README.md Outdated Show resolved Hide resolved

joyceerhl reviewed Nov 10, 2020

View reviewed changes

README.md Outdated Show resolved Hide resolved

claudiaregio and others added 4 commits November 9, 2020 17:41

Update README.md

82ce374

Co-authored-by: Joyce Er <[email protected]>

Update README.md

0863881

Co-authored-by: Joyce Er <[email protected]>

Update README.md

154bcdb

Co-authored-by: Joyce Er <[email protected]>

Edit step 3 in setup

ce6f3c3

joyceerhl approved these changes Nov 10, 2020

View reviewed changes

DonJayamanne requested changes Nov 10, 2020

View reviewed changes

IanMatthewHuff reviewed Nov 10, 2020

View reviewed changes

README.md Outdated Show resolved Hide resolved

IanMatthewHuff reviewed Nov 10, 2020

View reviewed changes

README.md Outdated

- Configure the debugger through the Debug Activity Bar



Copy link

Member

IanMatthewHuff Nov 10, 2020

Choose a reason for hiding this comment

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

Another todo here?

IanMatthewHuff reviewed Nov 10, 2020

View reviewed changes

README.md Outdated Show resolved Hide resolved

IanMatthewHuff reviewed Nov 10, 2020

View reviewed changes

README.md Show resolved Hide resolved

IanMatthewHuff reviewed Nov 10, 2020

View reviewed changes

README.md Outdated Show resolved Hide resolved

IanMatthewHuff reviewed Nov 10, 2020

View reviewed changes

README.md Outdated Show resolved Hide resolved

IanMatthewHuff requested changes Nov 10, 2020

View reviewed changes

Jupyter ReadMe 2

4fbdaee

rchiodo approved these changes Nov 11, 2020

View reviewed changes

claudiaregio added 2 commits November 10, 2020 16:27

plz let this be the last jupyter readme update

10411ed

Merge branch 'main' into claudiaregio/jupyterReadMe

ee7411b

claudiaregio requested review from IanMatthewHuff, DonJayamanne, greazer and joyceerhl November 11, 2020 00:37

IanMatthewHuff approved these changes Nov 11, 2020

View reviewed changes

DavidKutu approved these changes Nov 11, 2020

View reviewed changes

claudiaregio added 2 commits November 11, 2020 09:42

updated jupyter extension marketplace link

728c642

Merge branch 'claudiaregio/jupyterReadMe' of https://github.com/micro…

a2f06fd

…soft/vscode-jupyter into claudiaregio/jupyterReadMe

rchiodo merged commit 68bee5c into main Nov 11, 2020

rchiodo deleted the claudiaregio/jupyterReadMe branch November 11, 2020 17:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Claudiaregio/jupyter read me #430

Claudiaregio/jupyter read me #430

claudiaregio commented Nov 10, 2020

DonJayamanne left a comment

IanMatthewHuff Nov 10, 2020

claudiaregio Nov 10, 2020

IanMatthewHuff Nov 10, 2020

IanMatthewHuff Nov 10, 2020

IanMatthewHuff Nov 10, 2020 •

edited

Loading

IanMatthewHuff Nov 10, 2020

IanMatthewHuff Nov 10, 2020

claudiaregio Nov 10, 2020 •

edited

Loading

IanMatthewHuff Nov 10, 2020

IanMatthewHuff left a comment

IanMatthewHuff left a comment


		## Set up your environment
		- Step 2. Install the [Jupyter Extension](https://code.visualstudio.com/docs/python/python-tutorial#_prerequisites) in VS Code Insiders - CHANGE ME


		- Configure the debugger through the Debug Activity Bar
		<!-- use less words -->


		- Configure tests by running the `Configure Tests` command
		<img src=https://raw.githubusercontent.com/microsoft/vscode-jupyter/main/images/Jupyter%20README/CreateNewNotebook.png>

Claudiaregio/jupyter read me #430

Claudiaregio/jupyter read me #430

Conversation

claudiaregio commented Nov 10, 2020

DonJayamanne left a comment

Choose a reason for hiding this comment

IanMatthewHuff Nov 10, 2020

Choose a reason for hiding this comment

claudiaregio Nov 10, 2020

Choose a reason for hiding this comment

IanMatthewHuff Nov 10, 2020

Choose a reason for hiding this comment

IanMatthewHuff Nov 10, 2020

Choose a reason for hiding this comment

IanMatthewHuff Nov 10, 2020 • edited Loading

Choose a reason for hiding this comment

IanMatthewHuff Nov 10, 2020

Choose a reason for hiding this comment

IanMatthewHuff Nov 10, 2020

Choose a reason for hiding this comment

claudiaregio Nov 10, 2020 • edited Loading

Choose a reason for hiding this comment

IanMatthewHuff Nov 10, 2020

Choose a reason for hiding this comment

IanMatthewHuff left a comment

Choose a reason for hiding this comment

IanMatthewHuff left a comment

Choose a reason for hiding this comment

IanMatthewHuff Nov 10, 2020 •

edited

Loading

claudiaregio Nov 10, 2020 •

edited

Loading