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

DOC: Add Gitpod development documentation #18839

Merged
merged 5 commits into from
Apr 26, 2021
Merged

DOC: Add Gitpod development documentation #18839

merged 5 commits into from
Apr 26, 2021

Conversation

trallard
Copy link
Contributor

@trallard trallard commented Apr 23, 2021

This PR adds the following:

  • Documentation on how to use Gitpod for development
  • Images complementing the docs

Additional notes:

This is complementary to PR #18822

@melissawm I tried to find a good place for this docs but will defer to your best judgement (I also added to the TOC in dev/index.rst)

Copy link
Member

@melissawm melissawm left a comment

Choose a reason for hiding this comment

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

Thank you for this @trallard ! I left a few comments, some are very optional. I wonder if there´s a way to make the images a bit larger - the fonts on some of them are too small for me to make out the text and I think they add a lot of value to the docs. Otherwise, I think this is in the right place and is very well written!

doc/source/dev/development_gitpod.rst Outdated Show resolved Hide resolved
doc/source/dev/development_gitpod.rst Show resolved Hide resolved
doc/source/dev/development_gitpod.rst Show resolved Hide resolved
doc/source/dev/development_gitpod.rst Outdated Show resolved Hide resolved
doc/source/dev/development_gitpod.rst Outdated Show resolved Hide resolved
doc/source/dev/development_gitpod.rst Outdated Show resolved Hide resolved
doc/source/dev/development_gitpod.rst Outdated Show resolved Hide resolved
doc/source/dev/development_gitpod.rst Outdated Show resolved Hide resolved
doc/source/dev/development_gitpod.rst Outdated Show resolved Hide resolved
doc/source/dev/development_gitpod.rst Outdated Show resolved Hide resolved
@trallard
Copy link
Contributor Author

I can zoom everything in and get new images done. Should only take a couple of minutes.

trallard and others added 2 commits April 26, 2021 11:23
Co-authored-by: Melissa Weber Mendonça <melissawm@gmail.com>
Co-authored-by: Melissa Weber Mendonça <melissawm@gmail.com>
@charris
Copy link
Member

charris commented Apr 26, 2021

The text would be much nicer to read if you kept the lines < 80 characters. I suspect your editor is wrapping rather than breaking lines.

@trallard
Copy link
Contributor Author

Thanks for the review @charris and @melissawm!

Made some changes including replacing the images. Let me know what you think

Copy link
Member

@rgommers rgommers left a comment

Choose a reason for hiding this comment

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

Looks great!

@rgommers rgommers added this to the 1.21.0 release milestone Apr 26, 2021
@charris charris merged commit 967274c into numpy:main Apr 26, 2021
@charris
Copy link
Member

charris commented Apr 26, 2021

Thanks Tania.

@trallard
Copy link
Contributor Author

Happy to help.

@trallard trallard deleted the docs/gitpod branch April 27, 2021 09:33
verma16Ayush pushed a commit to verma16Ayush/numpy that referenced this pull request Apr 30, 2021
DOC: Add Gitpod development documentation
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.

None yet

4 participants