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.

Sign up for GitHub

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

Jump to bottom

Use the Diataxis Framework to restructure documentation #162

Closed
Tracked by #159
abkfenris opened this issue Mar 9, 2023 · 1 comment
Closed
Tracked by #159

Use the Diataxis Framework to restructure documentation #162

abkfenris opened this issue Mar 9, 2023 · 1 comment

Comments

@abkfenris
Copy link
Member

abkfenris commented Mar 9, 2023 •
edited
Loading

Diataxis framwork

  • Tutorials may really have a few separate tracks (server admin/data manager/xarray accessor user/client user)
  • How to's may be especially useful for more complicated plugin patterns/Q&A...
@abkfenris abkfenris mentioned this issue Mar 9, 2023
Open
9 tasks
@abkfenris
Copy link
Member Author

image

  • Getting Started
    • What is Xpublish / Vision
    • Installation
    • Tutorial
    • Ecosystem
  • User Guide
    • Plugin System
    • Building blocks of a server?
  • API Reference
  • Developer Guide

abkfenris added a commit to abkfenris/xpublish that referenced this issue Apr 7, 2023
@abkfenris
Docs revamp
d5b3b4c 
Start of a big revamp of the docs.
- Uses Pydata theme
- Enables MyST markdown and converts a lot of the docs to it (rst heading levels and git conflict formatting conflict, which was a fun discovery)
- Re-arranges things along the Diátaxis framework lines, or at least how they are being used in the PyData space
- Adds the vision or 'Why Xpublish' page
- Breaks the tutorial into sections and scaffolds sections for use of plugins

Closes xpublish-community#163 xpublish-community#165 xpublish-community#162 xpublish-community#166
abkfenris added a commit that referenced this issue May 11, 2023
@abkfenris
Docs revamp (#180)
18ec94a 
* Add methods to API docs and use typehints

Closes #160 #161

* Use the Pydata theme for docs

Closes #164

* Add methods to API docs and use typehints

Closes #160 #161

* Use the Pydata theme for docs

Closes #164

* Hide the top menu navigation from the index page

* Docs revamp

Start of a big revamp of the docs.
- Uses Pydata theme
- Enables MyST markdown and converts a lot of the docs to it (rst heading levels and git conflict formatting conflict, which was a fun discovery)
- Re-arranges things along the Diátaxis framework lines, or at least how they are being used in the PyData space
- Adds the vision or 'Why Xpublish' page
- Breaks the tutorial into sections and scaffolds sections for use of plugins

Closes #163 #165 #162 #166

* Update xarray-contrib to xpublish-community

* Pre-commit format markdown and docs code snippets

* Dataset router plugin tutorial and other doc tweaks

* Use literalinclude rather than duplicating doc code

* Remove some under-construction alerts
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@abkfenris