crate / crate/cratedb-guide

Content Curation Backlog

Open
#48 0 comments 0 reactions 0 assignees View on GitHub
cross linking guidance help wanted new content
Dominant language
No language data
Stars
3
Forks
4
Avg merge
3d 18h
Merged PRs (30d)
1

Description

# 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.

- https://github.com/crate/cratedb-guide/pull/29
- https://github.com/crate/cratedb-guide/pull/34
- https://github.com/crate/cratedb-guide/pull/35
- https://github.com/crate/cratedb-guide/pull/41
- https://github.com/crate/cratedb-guide/pull/42
- https://github.com/crate/cratedb-guide/pull/45
- https://github.com/crate/cratedb-guide/pull/46

### Iteration +1

- [x] Refine/balance between priority and style.
[The CrateDB Guide](https://cratedb.com/docs/guide/) should provide optimal guidance and appearance. On a previous development iteration, information conveyance was balanced. Currently, [it is not](https://github.com/crate/cratedb-guide/pull/40#issuecomment-1964822693). So, improve the appearance of the canonical main page again.
- [x] 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 https://github.com/crate/cratedb-guide/pull/42#pullrequestreview-1901765759.
- [ ] 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](https://cratedb.com/docs/guide/domain/timeseries/)
- [x] GH-53
- [ ] GH-54
- [x] [System Metrics](https://cratedb.com/docs/guide/integrate/metrics/) <= GH-56
- [x] [Administration / Troubleshooting](https://cratedb.com/docs/guide/admin/troubleshooting/) <= GH-55

### Iteration +3
- [ ] Remedy more walls of links on [Integrations](https://cratedb.com/docs/guide/integrate/) 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?
- [x] Improve section about [Upgrading](https://cratedb.com/docs/guide/admin/upgrade/).
https://github.com/crate/cratedb-guide/pull/43#discussion_r1504463903
- [x] Improve guidance/layout on page about [Performance](https://cratedb.com/docs/guide/performance/).
https://github.com/crate/cratedb-guide/pull/42#issuecomment-1964866956
- [ ] https://github.com/crate/cratedb-guide/issues/102

## General

### Content Formats
- [x] Convert reStructuredText to Markdown.
- [ ] Optimize images to use [Simplified Screenshots](https://thisisimportant.net/posts/screenshots-in-documentation/#use-simplified-screenshots) exclusively.
- [ ] Optimize images using `oxipng`.

### Content. Content. Content.
- [x] 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.
- [ ] Absorb other tutorials like those.
- https://github.com/crate/cratedb-guide/issues/19

### Layout. Structure. Layout. Structure.
- [ ] Discuss domain/topic (re-)grouping proposal / content categories.
- @marijaselakovic shared a suggestion at https://github.com/crate/cratedb-guides/issues/10.
- @karynzv also aimed to share a suggestion.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.