From 71cf786c1ebb3d67d32f2fab6b1b8889a84f3ab5 Mon Sep 17 00:00:00 2001 From: Tania Allard Date: Mon, 10 May 2021 11:50:46 +0100 Subject: DOC: Add troubleshoot items --- doc/source/dev/development_gitpod.rst | 26 +++++++++++++++------ .../dev/gitpod-imgs/gitpod-dashboard-stop.png | Bin 0 -> 26217 bytes 2 files changed, 19 insertions(+), 7 deletions(-) create mode 100644 doc/source/dev/gitpod-imgs/gitpod-dashboard-stop.png (limited to 'doc/source') diff --git a/doc/source/dev/development_gitpod.rst b/doc/source/dev/development_gitpod.rst index 282103cc5..f0c1c18f5 100644 --- a/doc/source/dev/development_gitpod.rst +++ b/doc/source/dev/development_gitpod.rst @@ -135,12 +135,12 @@ before working on your contributions. When using Gitpod, git is pre configured for you: #. You do not need to configure your git username, and email as this should be -#. done for you as you authenticated through GitHub. You can check the git -#. configuration with the command ``git config --list`` in your terminal. + done for you as you authenticated through GitHub. You can check the git + configuration with the command ``git config --list`` in your terminal. #. As you started your workspace from your own NumPy fork, you will by default -#. have both "upstream "and "origin "added as remotes. You can verify this by -#. typing ``git remote`` on your terminal or by clicking on the **branch name** -#. on the status bar (see image below). + have both "upstream "and "origin "added as remotes. You can verify this by + typing ``git remote`` on your terminal or by clicking on the **branch name** + on the status bar (see image below). .. image:: ./gitpod-imgs/NumPy-gitpod-branches.png :alt: Gitpod workspace branches plugin screenshot @@ -199,8 +199,8 @@ uses the rst extension with docutils. If you want to see the final output with the ``html`` theme you will need to rebuild the docs with ``make html`` and use Live Serve as described in option 1. -FAQ's ------ +FAQ's and troubleshooting +---------------------------- #. How long is my Gitpod workspace kept for? Your stopped workspace will be kept for 14 days and deleted afterwards if @@ -234,6 +234,18 @@ FAQ's it will shut down after 30 minutes. If you close the browser tab, it will shut down after 3 minutes. +#. My terminal is blank - there is no cursor and it's completely unresponsive + Unfortunately this is a known-issue on Gitpod's side. You can sort this issue in two ways: + + #. Create a new Gitpod workspace altogether. + #. Head to your `Gitpod dashboard `_ and locate + the running workspace. Hover on it and click on the **three dots menu** + and then click on **Stop**. When the workspace is completely stopped you + can click on its name to restart it again. + + .. image:: ./gitpod-imgs/gitpod-dashboard-stop.png + :alt: Gitpod dashboard and workspace menu screenshot + .. _Gitpod: https://www.gitpod.io/ .. _NumPy repository on GitHub: https://github.com/NumPy/NumPy .. _create your own fork: https://help.github.com/en/articles/fork-a-repo diff --git a/doc/source/dev/gitpod-imgs/gitpod-dashboard-stop.png b/doc/source/dev/gitpod-imgs/gitpod-dashboard-stop.png new file mode 100644 index 000000000..db3a570c1 Binary files /dev/null and b/doc/source/dev/gitpod-imgs/gitpod-dashboard-stop.png differ -- cgit v1.2.1 From 0bd55555177160b1b953711f93f09f0a42fa7214 Mon Sep 17 00:00:00 2001 From: Tania Allard Date: Mon, 10 May 2021 12:16:54 +0100 Subject: DOC: Fix lists and add images --- doc/source/dev/development_gitpod.rst | 34 +++++++++++++-------- .../dev/gitpod-imgs/gitpod-dashboard-stop.png | Bin 26217 -> 14185 bytes .../gitpod-imgs/gitpod-edit-permissions-repo.png | Bin 0 -> 5505 bytes 3 files changed, 22 insertions(+), 12 deletions(-) create mode 100644 doc/source/dev/gitpod-imgs/gitpod-edit-permissions-repo.png (limited to 'doc/source') diff --git a/doc/source/dev/development_gitpod.rst b/doc/source/dev/development_gitpod.rst index f0c1c18f5..619bfba3a 100644 --- a/doc/source/dev/development_gitpod.rst +++ b/doc/source/dev/development_gitpod.rst @@ -216,15 +216,12 @@ FAQ's and troubleshooting Absolutely! Any extensions you installed will be installed in your own workspace and preserved. -#. I registered on Gitpod but I still cannot see a ``Gitpod`` button in my - repositories - +#. I registered on Gitpod but I still cannot see a ``Gitpod`` button in my repositories. Head to https://gitpod.io/integrations and make sure you are logged in. Hover over GitHub and click on the three buttons that appear on the right. Click on edit permissions and make sure you have ``user:email``, - ``read:user``, and ``public_repo`` checked. - Click on **Update Permissions** and confirm the changes in the - GitHub application page. + ``read:user``, and ``public_repo`` checked. Click on **Update Permissions** + and confirm the changes in the GitHub application page. .. image:: ./gitpod-imgs/gitpod-edit-permissions-gh.png :alt: Gitpod integrations - edit GH permissions screenshot @@ -235,16 +232,29 @@ FAQ's and troubleshooting shut down after 3 minutes. #. My terminal is blank - there is no cursor and it's completely unresponsive - Unfortunately this is a known-issue on Gitpod's side. You can sort this issue in two ways: + Unfortunately this is a known-issue on Gitpod's side. You can sort this + issue in two ways: #. Create a new Gitpod workspace altogether. #. Head to your `Gitpod dashboard `_ and locate - the running workspace. Hover on it and click on the **three dots menu** - and then click on **Stop**. When the workspace is completely stopped you - can click on its name to restart it again. + the running workspace. Hover on it and click on the **three dots menu** + and then click on **Stop**. When the workspace is completely stopped you + can click on its name to restart it again. + + .. image:: ./gitpod-imgs/gitpod-dashboard-stop.png + :alt: Gitpod dashboard and workspace menu screenshot + +#. I authenticated through GitHub but I still cannot commit to the repository + through Gitpod. + + Head to https://gitpod.io/integrations and make sure you are logged in. + Hover over GitHub and click on the three buttons that appear on the right. + Click on edit permissions and make sure you have ``public_repo`` checked. + Click on **Update Permissions** and confirm the changes in the + GitHub application page. - .. image:: ./gitpod-imgs/gitpod-dashboard-stop.png - :alt: Gitpod dashboard and workspace menu screenshot + .. image:: ./gitpod-imgs/gitpod-edit-permissions-repo.png + :alt: Gitpod integrations - edit GH repository permissions screenshot .. _Gitpod: https://www.gitpod.io/ .. _NumPy repository on GitHub: https://github.com/NumPy/NumPy diff --git a/doc/source/dev/gitpod-imgs/gitpod-dashboard-stop.png b/doc/source/dev/gitpod-imgs/gitpod-dashboard-stop.png index db3a570c1..40f137745 100644 Binary files a/doc/source/dev/gitpod-imgs/gitpod-dashboard-stop.png and b/doc/source/dev/gitpod-imgs/gitpod-dashboard-stop.png differ diff --git a/doc/source/dev/gitpod-imgs/gitpod-edit-permissions-repo.png b/doc/source/dev/gitpod-imgs/gitpod-edit-permissions-repo.png new file mode 100644 index 000000000..8bfaff81c Binary files /dev/null and b/doc/source/dev/gitpod-imgs/gitpod-edit-permissions-repo.png differ -- cgit v1.2.1 From 6721946a9580c8032a45c178ae4b8730b32d6c83 Mon Sep 17 00:00:00 2001 From: Tania Allard Date: Mon, 10 May 2021 13:48:24 +0100 Subject: DOC: Fix list indentation --- doc/source/dev/development_gitpod.rst | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) (limited to 'doc/source') diff --git a/doc/source/dev/development_gitpod.rst b/doc/source/dev/development_gitpod.rst index 619bfba3a..147cf369c 100644 --- a/doc/source/dev/development_gitpod.rst +++ b/doc/source/dev/development_gitpod.rst @@ -46,10 +46,8 @@ The best way to work on NumPy as a contributor is by making a fork of the repository first. #. Browse to the `NumPy repository on GitHub`_ and `create your own fork`_. - #. Browse to your fork. Your fork will have a URL like -#. https://github.com/melissawm/NumPy, except with your GitHub username in -#. place of "melissawm". + https://github.com/melissawm/NumPy, except with your GitHub username in place of ``melissawm``. Starting Gitpod ---------------- @@ -78,7 +76,7 @@ repository: might be some actions running. This will ensure that you have a development version of NumPy installed and that the docs are being pre-built for you. -#. Once the build is complete, you can :ref:`test the build` by +#. When your workspace is ready, you can :ref:`test the build` by entering:: $ python runtests.py -v -- cgit v1.2.1 From 12c2f00bfa34b8257ca9f118179cadbb82bc0428 Mon Sep 17 00:00:00 2001 From: Tania Allard Date: Mon, 10 May 2021 20:20:02 +0100 Subject: DOC: Fix indentation Co-authored-by: Ross Barnowski --- doc/source/dev/development_gitpod.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/source') diff --git a/doc/source/dev/development_gitpod.rst b/doc/source/dev/development_gitpod.rst index 147cf369c..9dc7230fb 100644 --- a/doc/source/dev/development_gitpod.rst +++ b/doc/source/dev/development_gitpod.rst @@ -47,7 +47,7 @@ repository first. #. Browse to the `NumPy repository on GitHub`_ and `create your own fork`_. #. Browse to your fork. Your fork will have a URL like - https://github.com/melissawm/NumPy, except with your GitHub username in place of ``melissawm``. + https://github.com/melissawm/NumPy, except with your GitHub username in place of ``melissawm``. Starting Gitpod ---------------- -- cgit v1.2.1 From a44e51125e0db90d57c5a2701ebb8e669a67e03d Mon Sep 17 00:00:00 2001 From: Tania Allard Date: Mon, 10 May 2021 20:20:44 +0100 Subject: DOC: Fix lists indentation Co-authored-by: Ross Barnowski --- doc/source/dev/development_gitpod.rst | 1 + 1 file changed, 1 insertion(+) (limited to 'doc/source') diff --git a/doc/source/dev/development_gitpod.rst b/doc/source/dev/development_gitpod.rst index 9dc7230fb..09c4eabd0 100644 --- a/doc/source/dev/development_gitpod.rst +++ b/doc/source/dev/development_gitpod.rst @@ -230,6 +230,7 @@ FAQ's and troubleshooting shut down after 3 minutes. #. My terminal is blank - there is no cursor and it's completely unresponsive + Unfortunately this is a known-issue on Gitpod's side. You can sort this issue in two ways: -- cgit v1.2.1 From 9e37c8eb966e2d1160a55a797ad059de7f1ee8c2 Mon Sep 17 00:00:00 2001 From: Tania Allard Date: Mon, 10 May 2021 20:20:57 +0100 Subject: DOC: Remove extra -- Co-authored-by: Ross Barnowski --- doc/source/dev/development_gitpod.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/source') diff --git a/doc/source/dev/development_gitpod.rst b/doc/source/dev/development_gitpod.rst index 09c4eabd0..ba80bb266 100644 --- a/doc/source/dev/development_gitpod.rst +++ b/doc/source/dev/development_gitpod.rst @@ -198,7 +198,7 @@ If you want to see the final output with the ``html`` theme you will need to rebuild the docs with ``make html`` and use Live Serve as described in option 1. FAQ's and troubleshooting ----------------------------- +------------------------- #. How long is my Gitpod workspace kept for? Your stopped workspace will be kept for 14 days and deleted afterwards if -- cgit v1.2.1 From 70d3224e5207e66565803b7f9563b81ea995fc2c Mon Sep 17 00:00:00 2001 From: Tania Allard Date: Mon, 10 May 2021 21:00:29 +0100 Subject: DOC: Make FAQ titles --- doc/source/dev/development_gitpod.rst | 118 ++++++++++++++++++---------------- 1 file changed, 64 insertions(+), 54 deletions(-) (limited to 'doc/source') diff --git a/doc/source/dev/development_gitpod.rst b/doc/source/dev/development_gitpod.rst index ba80bb266..92cca81fc 100644 --- a/doc/source/dev/development_gitpod.rst +++ b/doc/source/dev/development_gitpod.rst @@ -35,7 +35,7 @@ Make sure to select **All repositories** access option to avoid issues with permissions later on. Click on the green **Install** button .. image:: ./gitpod-imgs/installing-gitpod-io.png - :alt: Gitpod repository access and installation screenshot + :alt: Gitpod repository access and installation screenshot This will install the necessary hooks for the integration. @@ -57,7 +57,7 @@ which will add a **Gitpod** button next to the **Code** button in the repository: .. image:: ./gitpod-imgs/NumPy-github.png - :alt: NumPy repository with Gitpod button screenshot + :alt: NumPy repository with Gitpod button screenshot #. If you install the extension - you can click the **Gitpod** button to start a new workspace. @@ -79,7 +79,7 @@ repository: #. When your workspace is ready, you can :ref:`test the build` by entering:: - $ python runtests.py -v + $ python runtests.py -v ``runtests.py`` is another script in the NumPy root directory. It runs a suite of tests that make sure NumPy is working as it should, and ``-v`` activates the @@ -93,11 +93,11 @@ can check the Getting started `VSCode docs`_ to familiarize yourself with it. Your workspace will look similar to the image below: .. image:: ./gitpod-imgs/gitpod-workspace.png - :alt: Gitpod workspace screenshot + :alt: Gitpod workspace screenshot .. note:: By default, VSCode initializes with a light theme. You can change to - a dark theme by with the keyboard shortcut :kbd:`Cmd-K Cmd-T` in Mac or - :kbd:`Ctrl-K Ctrl-T` in Linux and Windows. + a dark theme by with the keyboard shortcut :kbd:`Cmd-K Cmd-T` in Mac or + :kbd:`Ctrl-K Ctrl-T` in Linux and Windows. We have marked some important sections in the editor: @@ -109,7 +109,7 @@ We have marked some important sections in the editor: #. GitHub Pull Requests extension - you can use this to work with Pull Requests from your workspace. #. Marketplace extensions - we have added some essential extensions to the NumPy -#. Gitpod. Still, you can also install other extensions or syntax highlighting + Gitpod. Still, you can also install other extensions or syntax highlighting themes for your user, and these will be preserved for you. #. Your workspace directory - by default, it is ``/workspace/numpy``. **Do not change this** as this is the only directory preserved in Gitpod. @@ -136,12 +136,12 @@ When using Gitpod, git is pre configured for you: done for you as you authenticated through GitHub. You can check the git configuration with the command ``git config --list`` in your terminal. #. As you started your workspace from your own NumPy fork, you will by default - have both "upstream "and "origin "added as remotes. You can verify this by + have both ``upstream`` and ``origin`` added as remotes. You can verify this by typing ``git remote`` on your terminal or by clicking on the **branch name** on the status bar (see image below). -.. image:: ./gitpod-imgs/NumPy-gitpod-branches.png - :alt: Gitpod workspace branches plugin screenshot + .. image:: ./gitpod-imgs/NumPy-gitpod-branches.png + :alt: Gitpod workspace branches plugin screenshot Rendering the NumPy documentation ---------------------------------- @@ -188,8 +188,7 @@ uses the rst extension with docutils. .. image:: ./gitpod-imgs/vscode-rst.png :alt: Gitpod workspace VSCode open rst screenshot -#. As you work on the document, you will see a live rendering of it on the - editor. +#. As you work on the document, you will see a live rendering of it on the editor. .. image:: ./gitpod-imgs/rst-rendering.png :alt: Gitpod workspace VSCode rst rendering screenshot @@ -200,60 +199,71 @@ rebuild the docs with ``make html`` and use Live Serve as described in option 1. FAQ's and troubleshooting ------------------------- -#. How long is my Gitpod workspace kept for? - Your stopped workspace will be kept for 14 days and deleted afterwards if - you do not use them. +How long is my Gitpod workspace kept for? +***************************************** -#. Can I come back to a previous workspace? - Yes, let's say you stepped away for a while and you want to carry on working - on your NumPy contributions. You need to visit https://gitpod.io/workspaces - and click on the workspace you want to spin up again. All your changes will - be there as you last left them. +Your stopped workspace will be kept for 14 days and deleted afterwards if you do +not use them. -#. Can I install additional VSCode extensions? - Absolutely! Any extensions you installed will be installed in your own - workspace and preserved. +Can I come back to a previous workspace? +***************************************** -#. I registered on Gitpod but I still cannot see a ``Gitpod`` button in my repositories. - Head to https://gitpod.io/integrations and make sure you are logged in. - Hover over GitHub and click on the three buttons that appear on the right. - Click on edit permissions and make sure you have ``user:email``, - ``read:user``, and ``public_repo`` checked. Click on **Update Permissions** - and confirm the changes in the GitHub application page. +Yes, let's say you stepped away for a while and you want to carry on working on +your NumPy contributions. You need to visit https://gitpod.io/workspaces and +click on the workspace you want to spin up again. All your changes will be there +as you last left them. - .. image:: ./gitpod-imgs/gitpod-edit-permissions-gh.png - :alt: Gitpod integrations - edit GH permissions screenshot +Can I install additional VSCode extensions? +******************************************* -#. How long does my workspace stay active if I'm not using it? - If you keep your workspace open in a browser tab but don't interact with it, - it will shut down after 30 minutes. If you close the browser tab, it will - shut down after 3 minutes. +Absolutely! Any extensions you installed will be installed in your own workspace +and preserved. -#. My terminal is blank - there is no cursor and it's completely unresponsive +I registered on Gitpod but I still cannot see a ``Gitpod`` button in my repositories. +************************************************************************************* - Unfortunately this is a known-issue on Gitpod's side. You can sort this - issue in two ways: +Head to https://gitpod.io/integrations and make sure you are logged in. +Hover over GitHub and click on the three buttons that appear on the right. +Click on edit permissions and make sure you have ``user:email``, +``read:user``, and ``public_repo`` checked. Click on **Update Permissions** +and confirm the changes in the GitHub application page. - #. Create a new Gitpod workspace altogether. - #. Head to your `Gitpod dashboard `_ and locate - the running workspace. Hover on it and click on the **three dots menu** - and then click on **Stop**. When the workspace is completely stopped you - can click on its name to restart it again. +.. image:: ./gitpod-imgs/gitpod-edit-permissions-gh.png + :alt: Gitpod integrations - edit GH permissions screenshot - .. image:: ./gitpod-imgs/gitpod-dashboard-stop.png - :alt: Gitpod dashboard and workspace menu screenshot +How long does my workspace stay active if I'm not using it? +*********************************************************** -#. I authenticated through GitHub but I still cannot commit to the repository - through Gitpod. +If you keep your workspace open in a browser tab but don't interact with it, +it will shut down after 30 minutes. If you close the browser tab, it will +shut down after 3 minutes. - Head to https://gitpod.io/integrations and make sure you are logged in. - Hover over GitHub and click on the three buttons that appear on the right. - Click on edit permissions and make sure you have ``public_repo`` checked. - Click on **Update Permissions** and confirm the changes in the - GitHub application page. +My terminal is blank - there is no cursor and it's completely unresponsive +************************************************************************** - .. image:: ./gitpod-imgs/gitpod-edit-permissions-repo.png - :alt: Gitpod integrations - edit GH repository permissions screenshot +Unfortunately this is a known-issue on Gitpod's side. You can sort this +issue in two ways: + +#. Create a new Gitpod workspace altogether. +#. Head to your `Gitpod dashboard `_ and locate + the running workspace. Hover on it and click on the **three dots menu** + and then click on **Stop**. When the workspace is completely stopped you + can click on its name to restart it again. + +.. image:: ./gitpod-imgs/gitpod-dashboard-stop.png + :alt: Gitpod dashboard and workspace menu screenshot + +I authenticated through GitHub but I still cannot commit to the repository through Gitpod. +****************************************************************************************** + +Head to https://gitpod.io/integrations and make sure you are logged in. +Hover over GitHub and click on the three buttons that appear on the right. +Click on edit permissions and make sure you have ``public_repo`` checked. +Click on **Update Permissions** and confirm the changes in the +GitHub application page. + +.. image:: ./gitpod-imgs/gitpod-edit-permissions-repo.png + :alt: Gitpod integrations - edit GH repository permissions screenshot .. _Gitpod: https://www.gitpod.io/ .. _NumPy repository on GitHub: https://github.com/NumPy/NumPy -- cgit v1.2.1 From 32322042ec59a07541bd4fba252fbcf9914d94b5 Mon Sep 17 00:00:00 2001 From: Tania Allard Date: Mon, 10 May 2021 21:05:52 +0100 Subject: DOC: Make screenshot labels bigger --- doc/source/dev/gitpod-imgs/gitpod-workspace.png | Bin 118160 -> 201069 bytes 1 file changed, 0 insertions(+), 0 deletions(-) (limited to 'doc/source') diff --git a/doc/source/dev/gitpod-imgs/gitpod-workspace.png b/doc/source/dev/gitpod-imgs/gitpod-workspace.png index 618b7063b..a65c9bd7e 100644 Binary files a/doc/source/dev/gitpod-imgs/gitpod-workspace.png and b/doc/source/dev/gitpod-imgs/gitpod-workspace.png differ -- cgit v1.2.1