DOC: Reorganize Getting Started documentation pages #32389

mroeschke · 2020-03-02T07:24:43Z

closes DOC: Consolidate pages under /docs/getting_started #32308

Issue Related:

getting_started/index.html removes 10 minutes to pandas, Essential basic functionality and Intro to data structures from the toctree and moves them as links in user_guide/index.html
getting_started/tutorials.html now only references community tutorials
the pandas cheatsheet is now referenced at the bottom Tutorial section of getting_started/index.html

Misc:

Lowercases Pandas to pandas
Some rephrasing

MarcoGorelli · 2020-03-02T11:36:30Z

doc/source/getting_started/index.rst

@@ -23,7 +21,7 @@ Before you can use pandas, you’ll need to get it installed.
                <div class="card-body">
                    <p class="card-text">

-Pandas is part of the `Anaconda <http://docs.continuum.io/anaconda/>`__ distribution and can be
+pandas is part of the `Anaconda <http://docs.continuum.io/anaconda/>`__ distribution and can be


in #32388 , pandas is being written

*pandas*

, should that be done here as well for consistency?

We want to move *pandas* to pandas #32316

mroeschke · 2020-03-02T17:28:02Z

My sphinx-foo is a bit poor.

I see I'm getting these doc build warnings

2020-03-02T07:41:43.8295810Z /home/runner/work/pandas/pandas/doc/source/getting_started/10min.rst: WARNING: document isn't included in any toctree
2020-03-02T07:41:43.8296699Z /home/runner/work/pandas/pandas/doc/source/getting_started/basics.rst: WARNING: document isn't included in any toctree
2020-03-02T07:41:43.8297521Z /home/runner/work/pandas/pandas/doc/source/getting_started/dsintro.rst: WARNING: document isn't included in any toctree

And we have a note in the docs

.. If you update this toctree, also update the manual toctree in the
   main index.rst.template

But still unsure what I need to change in index.rst.template

mroeschke · 2020-03-02T17:29:05Z

cc @jorisvandenbossche

TomAugspurger · 2020-03-02T20:35:44Z

@mroeschke for the warnings, I think you need to add a toctree to tutorials.rst with those (10min, etc.) documents included. Otherwise they won't be included in the output.

jorisvandenbossche · 2020-03-02T20:42:23Z

Or alternatively put :orphan: on the top of the rst page that is not included in any toctree but we still want to include in the output, which will silence the warnings as well.

However, I think we want to include it in a toctree for better visibility?

TomAugspurger · 2020-03-02T20:44:53Z

Yeah, I think including it is better. I think putting it in an :orphan: page also kinda breaks "next" and "previous" links.

jorisvandenbossche · 2020-03-02T20:43:44Z

doc/source/getting_started/index.rst

    intro_tutorials/index
-    basics
-    dsintro


I don't think we should just remove basics and dsintro, but keep them somewhere in the docs. I personally would move them to the user guide, but so that means they need to be added to the toctree there if we want to do that.

I added them as links in the user guide but hadn't added it to the toctree there yet.

https://github.com/pandas-dev/pandas/pull/32389/files#diff-e81313c8de3a67eb46e6744b7c895af2R15

jorisvandenbossche · 2020-03-02T20:48:36Z

doc/source/getting_started/index.rst

+Tutorials
+---------
+
+For a quick introduction to pandas, see :ref:`10 Minutes to pandas<10min>`.


I personally find "quick overview of pandas functionality" a better description, as I don't it a very "introductory" in the sense of that it doesn't explain much, but mainly shows briefly most areas of pandas functionality.

(but as I said on the issue, I am not fully sure what best to do with or how to frame this 10min page)

WillAyd

lgtm

jorisvandenbossche

This will also need redirects for the moved pages

jorisvandenbossche · 2020-03-03T07:56:07Z

I am not sure about moving 10min to the user guide. In any case, based on its name I would say it belongs in the getting started section.

cc @datapythonista are you OK with moving dsintro.rst and basics.rst back to the user guide? (since you put them in the getting started section when the split was done)

datapythonista

I'm open to move 10min... to the user guide.

The division I made was thinking on what documentation was for people new to pandas, and what for existing users. And those felt more like they were for people getting started.

But I think ideally the getting started documentation should be something to be read sequentially by new users, and I guess moving those to the user guide is moving in that direction.

Happy with both.

datapythonista · 2020-03-03T14:10:19Z

doc/source/getting_started/index.rst

@@ -3,14 +3,12 @@
 .. _getting_started:

 ===============
-Getting started
+Getting Started


We are moving in the opposite direction, see #31114

datapythonista · 2020-03-03T14:11:51Z

doc/source/getting_started/index.rst

-                            also provides the <code>data set</code> corresponding to the pandas <code>data.frame</code>.
-                            Also vectorized operations, filtering, string processing operations,... from SAS have similar
+                            also provides the <code>data set</code> corresponding to the pandas <code>dataframe</code>.
+                            Also vectorized operations, filtering, string processing operations, and more from SAS have similar


You'll know better, but may be this is clearer?

Suggested change

Also vectorized operations, filtering, string processing operations, and more from SAS have similar

Also SAS vectorized operations, filtering, string processing operations, and more have similar

mroeschke · 2020-03-04T06:20:31Z

doc/redirects.csv

@@ -7,13 +7,10 @@ release,whatsnew/index

 # getting started
 install,getting_started/install
-10min,getting_started/10min


Not sure how to specify the redirects if they switch sections @jorisvandenbossche

I think this can be 10min,user_guide/10min ?

Perfect that worked.

…rted

mroeschke · 2020-03-10T23:51:12Z

Planning on merging tomorrow if there are no further comments.

* DOC: Reorganize Getting Started documentation pages * Move some docs to user_guide, and adjust phrasing * Modify redirects, fix phrasing in getting_started * modify redirects Co-authored-by: Matt Roeschke <mroeschke@housecanary.com>

DOC: Reorganize Getting Started documentation pages

36ebffd

mroeschke added the Docs label Mar 2, 2020

MarcoGorelli reviewed Mar 2, 2020

View reviewed changes

jorisvandenbossche reviewed Mar 2, 2020

View reviewed changes

Move some docs to user_guide, and adjust phrasing

ac68cd2

WillAyd approved these changes Mar 3, 2020

View reviewed changes

jorisvandenbossche requested changes Mar 3, 2020

View reviewed changes

datapythonista approved these changes Mar 3, 2020

View reviewed changes

Modify redirects, fix phrasing in getting_started

7244976

mroeschke commented Mar 4, 2020

View reviewed changes

Matt Roeschke added 2 commits March 5, 2020 17:56

Merge remote-tracking branch 'upstream/master' into reorg_getting_sta…

0a429a9

…rted

modify redirects

1abd2f2

mroeschke merged commit 1f2385e into pandas-dev:master Mar 11, 2020

mroeschke deleted the reorg_getting_started branch March 11, 2020 22:15

mroeschke added this to the 1.1 milestone Mar 11, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOC: Reorganize Getting Started documentation pages #32389

DOC: Reorganize Getting Started documentation pages #32389

mroeschke commented Mar 2, 2020

MarcoGorelli Mar 2, 2020 •

edited

Loading

mroeschke Mar 2, 2020

mroeschke commented Mar 2, 2020

mroeschke commented Mar 2, 2020

TomAugspurger commented Mar 2, 2020

jorisvandenbossche commented Mar 2, 2020

TomAugspurger commented Mar 2, 2020

jorisvandenbossche Mar 2, 2020

mroeschke Mar 3, 2020

jorisvandenbossche Mar 2, 2020

WillAyd left a comment

jorisvandenbossche left a comment

jorisvandenbossche commented Mar 3, 2020

datapythonista left a comment

datapythonista Mar 3, 2020

datapythonista Mar 3, 2020

mroeschke Mar 4, 2020

jorisvandenbossche Mar 4, 2020

mroeschke Mar 7, 2020

mroeschke commented Mar 10, 2020

	Also vectorized operations, filtering, string processing operations, and more from SAS have similar
	Also SAS vectorized operations, filtering, string processing operations, and more have similar

DOC: Reorganize Getting Started documentation pages #32389

DOC: Reorganize Getting Started documentation pages #32389

Conversation

mroeschke commented Mar 2, 2020

MarcoGorelli Mar 2, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mroeschke commented Mar 2, 2020

mroeschke commented Mar 2, 2020

TomAugspurger commented Mar 2, 2020

jorisvandenbossche commented Mar 2, 2020

TomAugspurger commented Mar 2, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

WillAyd left a comment

Choose a reason for hiding this comment

jorisvandenbossche left a comment

Choose a reason for hiding this comment

jorisvandenbossche commented Mar 3, 2020

datapythonista left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mroeschke commented Mar 10, 2020

MarcoGorelli Mar 2, 2020 •

edited

Loading