Content Curation Backlog

[amotl]

Backlogs Everywhere

Feedback about the items listed below is much welcome. Be it a small guiding comment, starting a discussion, or even suggestions submitted on behalf of patches, any kind contribution will be appreciated.

By Iteration

Iteration +0

In order to unflatten the new cratedb-guide, a bit of content has been slotted in, mostly from external resources.

• [CONTENT] Refactoring: Absorb tutorial-like references and content from crate-clients-tools #29
• [CONTENT] Reshaping: Converge into the layout of crate-clients-tools #34
• [CONTENT] Reshaping: Rework "Getting Started" section #35
• Performance: Reference articles about performance tricks for SQL SELECT queries #41
• Performance: Make section a first-level item #42
• Performance: Add links to downsampling tutorials #45
• Administration/Clustering: Reference articles about scaling clusters #46

Iteration +1

• Refine/balance between priority and style.
  The CrateDB Guide should provide optimal guidance and appearance. On a previous development iteration, information conveyance was balanced. Currently, it is not. So, improve the appearance of the canonical main page again.
• Remedy wall of tiles on main index page, eventually switching back to a 3-column subsection layout on the topmost page section. See discussion at Performance: Make section a first-level item #42 (review).
• Apply more "tiling"-style guidance to a few other pages. We are sure this can be applied to many. ;]
  • https://cratedb.com/docs/guide/domain/
  • https://cratedb.com/docs/guide/reference-architectures/

Iteration +2

Improve sections about specific application domains and other sections more significantly.

• Time Series
  • Evolve "Features" and "Application Domains" sections #53
  • TSML Primer: Add article series about "Machine Learning for Time Series Data" #54
• System Metrics <= Improve section about "System Metrics" #56
• Administration / Troubleshooting <= Troubleshooting: Provide concise troubleshooting guidelines #55

Iteration +3

• Remedy more walls of links on Integrations page.
  No idea how, because it's a massive matrix of information to be conveyed over there. Maybe use a new kind of small-tiled layout, or just use an improved table variant?
• Improve section about Upgrading.
  Administration/Upgrading: Add index page for "Upgrading" section #43 (comment)
• Improve guidance/layout on page about Performance.
  Performance: Make section a first-level item #42 (comment)

General

Content Formats

• Convert reStructuredText to Markdown.
• Optimize images to use Simplified Screenshots exclusively.
• Optimize images using oxipng.

Content. Content. Content.

• Cross-reference content from https://community.cratedb.com/t/overview-of-cratedb-integration-tutorials/1015
• Cross-reference and/or embed other material, also of different media types, like Video/Webinar content, Jupyter Notebooks, and Slide Decks.

Layout. Structure. Layout. Structure.

• Discuss domain/topic (re-)grouping proposal / content categories.
  - @marijaselakovic shared a suggestion at CrateDB Guide: Rework categorization / grouping #10.
  - @karynzv also aimed to share a suggestion.