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

Some things we can improve in the documentation #412

Open
7 tasks
choldgraf opened this issue Mar 30, 2019 · 2 comments
Open
7 tasks

Some things we can improve in the documentation #412

choldgraf opened this issue Mar 30, 2019 · 2 comments

Comments

@choldgraf
Copy link
Collaborator

choldgraf commented Mar 30, 2019

A few thoughts from some recent conversations in the Discourse:

https://discourse.jupyter.org/t/whats-the-difference-between-jupyter-org-and-jupyter-readthedocs-io/622

Here's a rough to-do list of items that people could help out with on this site. I can try to tackle some of these things in the coming weeks, but I'd also love to review pull requests from other people to help out as well!

Note: I'm not going to mention any major design standardizations, because I think that should use something like a JEP since it's so big

Things to do in the jupyter.readthedocs.io page

  • Update the quickstart page to direct to the quickstarts of our various sub-projects
  • Update the try jupyter page to mention Binder
  • Update the visual overview of projects to reflect new projects etc
  • Update the how do I know which packages I need page to be up to date with tech (maybe also split this into different sections, since there are now several options for some use-cases (e.g. jupyterlab + nteract + notebook interface)
  • Update the community guides page with more up-to-date info about meetings etc
  • Update the contributor guides to include more up-to-date information about how we're doing things in jupyter land
  • Add a page that links out to other blog posts, presentations, etc about the Jupyter ecosystem

Folks should also feel free to update/edit/add to this list if they like!

@jhermann
Copy link
Contributor

What about a page listing major conferences (incl. YouTube channels), highlighting some talks (introductory videos, plus especially informative ones), and a section with blog posts (organized on a time line).

@choldgraf
Copy link
Collaborator Author

choldgraf commented Mar 30, 2019

great idea - adding to list. @mpacer just gave a nice talk at Strata where she also referenced a bunch of other talks that she's given in the last few years, and I was thinking it'd be great if we had a place that could collect these kinds of things

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants