Parcourir la source

WIP: Update XKCD tutorial (#5148)

* Add link to conda install docs to XKCD

In case people want more details or get stuck.

* Clarify that cookiecutter creates a new folder

* Fix cookiecutter default value for name and repository
Saul Shanabrook il y a 6 ans
Parent
commit
4600c84999
1 fichiers modifiés avec 6 ajouts et 3 suppressions
  1. 6 3
      docs/source/developer/xkcd_extension_tutorial.rst

+ 6 - 3
docs/source/developer/xkcd_extension_tutorial.rst

@@ -56,6 +56,9 @@ the ``conda`` package manager.
 
     source ~/miniconda/bin/activate
 
+For more detail on installing miniconda, see
+`Conda's installation documentation <https://conda.io/docs/user-guide/install/index.html>`__.
+
 .. _install-nodejs-jupyterlab-etc-in-a-conda-environment:
 
 Install NodeJS, JupyterLab, etc. in a conda environment
@@ -106,6 +109,7 @@ Initialize the project from a cookiecutter
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Next use cookiecutter to create a new project for your extension.
+This will create a new folder for your extension in your current directory.
 
 .. code:: bash
 
@@ -117,10 +121,9 @@ cookiecutter prompts.
 ::
 
     author_name []: Your Name
-    extension_name [jupyterlab_myextension]: jupyterlab_xkcd
+    extension_name [myextension]: jupyterlab_xkcd
     project_short_description [A JupyterLab extension.]: Show a random xkcd.com comic in a JupyterLab panel
-    repository [https://github.com/my_name/jupyterlab_myextension]: Your repository
-    url
+    repository [https://github.com/my_name/jupyterlab_myextension]: https://github.com/my_name/jupyterlab_xkcd
 
 Note: if not using a repository, leave the field blank. You can come
 back and edit the repository links in the ``package.json`` file later.