NCAS-CMS / NCAS-CMS/cf-python

Docs: include a 'How do I...?' table to direct on common tasks

Open
#792 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Python
Stars
150
Forks
23
Avg merge
1d 11h
Merged PRs (30d)
2

Description

As part of our summit this week, we have identified that users would benefit from a page in the documentation which centers around a table which list common tasks that a user might want to do and maps them to relevant methods and their API reference pages; examples; and documentation sections.

A great example of this is an equivalent table in the xarray docs. As well as pointing to methods of direct relevance as per that table, we can include some extra columns which point to relevant sections of the Tutorial and relevant recipes, where applicable.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the equivalent “How do I...?” table in the xarray documentation and then inspect this repository’s existing documentation structure. Create a documentation page that maps common user tasks to relevant methods, API references, examples, tutorials, and recipes where applicable; done means the table provides those navigation links for the identified tasks.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.