Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Improve structure for "Getting Started" section

See original GitHub issue

Related to #3687. Suggesting new structure for “Getting Started” section, which is intended as a starting point for Modin users.

Getting Started/
├─ *Quickstart Guide (minimal install & setup script, 1-line replacement, mini-benchmark to demo speedup, same as updated README)
├─ Installation (pip, conda, source)/
├─ *Example (link to 1-2 notebook ex of how Modin is used for XYZ)
├─ *Tutorial (link to tutorial notebooks)
├─ Using Modin/
│  ├─ Using Modin locally
│  ├─ Using Modin in a cluster
├─ FAQs
├─ Troubleshooting
├─ Why use Modin?/
│  ├─ Modin vs. pandas
│  ├─ Out of Core in Modin
│  ├─ Modin vs. other distributed dataframes (disclaimer/overview)
│  ├─│  ├─ Modin vs. Dask DataFrame (#3779)
│  ├─│  ├─ Modin vs. Koalas

* indicates that the documentation page would have an associated notebook. (edited based on thread below)

Currently, the tutorial notebooks are here, which is not linked in the current docs (see #2412).

Note that this PR will not include new files for:

│  ├─ FAQs
│  ├─ Troubleshooting

given that it will be part of #2635.

Beyond the Getting Started Section, the overall top-level guide should be:

Getting Started
Usage Guide
Supported APIs
Developer
Contact

Issue Analytics

State:
Created 2 years ago
Comments:15 (15 by maintainers)

Top GitHub Comments

2reactions

YarShevcommented, Dec 16, 2021

I like the addition of a section that explains how to use modin better that doesn’t dive right into the advanced or experimental features, and I think Usage Guide is a good name for it. It makes me think a lot of the Advanced Features section could be folded into Usage Guide under a usage_guide/advanced section.

@dorisjlee, @jeffreykennethli’ comment makes sense to me.

Agree with this - I think the ordering should be:

Getting Started Usage Guide Supported APIs Developer Contact

I would rename Developer section to Developer Guide to resemble pandas docs.

2reactions

jeffreykennethlicommented, Dec 16, 2021

Re: #3864

I like the addition of a section that explains how to use modin better that doesn’t dive right into the advanced or experimental features, and I think Usage Guide is a good name for it. It makes me think a lot of the Advanced Features section could be folded into Usage Guide under a usage_guide/advanced section.

Any features in Advanced Usage we deem to be too experimental can go under a usage_guide/experimental.

order it to be before the “Developer” section?

Agree with this - I think the ordering should be:

Getting Started
Usage Guide
Supported APIs
Developer
Contact

Top Results From Across the Web

How to Write a Getting Started Guide - DocumentWrite

This guide will help you learn some basic structure around building a guide and learn some key tips for creating quality Getting Started...

How can I structure my document to make it more accessible?

Organizing your page with helpful titles and headings creates an outline that helps your audience access the most important information more ...

Structure of a Research Paper: Tips to Improve Your Manuscript

Avoid superfluous information and use parallel structures. Summarize your research in the abstract. Explain the importance of your research in ...

5 Lessons I've Learned on How to Structure Code | by Daan

Structuring code is a hard, yet crucial part of coding. Writing well-structured code takes proper thinking, understanding of design patterns ...

Implementing the Text Structure Strategy in Your Classroom

The Text Structure Strategy (TSS) stems from research showing that the content of most texts is organized using a hierarchical structure. The information ......