Tutorials: Add article-info widgets to all tutorials

[amotl]

About

On certain articles/pages like tutorials, inform about authorship, creation date, and reading time, like Discourse is doing it.

Preview (samples)

• https://cratedb-guide--436.org.readthedocs.build/feature/document/tutorial.html
• https://cratedb-guide--436.org.readthedocs.build/topic/timeseries/learn/with-metadata.html
• https://cratedb-guide--436.org.readthedocs.build/integrate/debezium/tutorial.html (original)
• https://cratedb-guide--436.org.readthedocs.build/integrate/locust/tutorial.html (original)
• https://cratedb-guide--436.org.readthedocs.build/integrate/airflow/data-retention-hot-cold.html (original)

[coderabbitai]

Walkthrough

Adds article metadata blocks across 16 documentation files, introducing standardized article-info front matter with author, avatar, date, and read-time attributes. Some files also receive content expansions or structural reorganization.

Changes

Cohort / File(s)	Change Summary
Article-info metadata additions docs/feature/document/tutorial.md, docs/feature/search/fts/tutorial.md, docs/integrate/airflow/data-retention-policy.md, docs/integrate/airflow/export-s3.md, docs/integrate/airflow/import-parquet.md, docs/integrate/grafana/tutorial.md, docs/integrate/pandas/tutorial-jupyter.md, docs/integrate/tensorflow/tutorial.md	Adds article-info front matter block with avatar, author, date, read-time, and styling metadata; no content changes.
Article-info metadata + content expansion docs/integrate/airflow/data-retention-hot-cold.md, docs/integrate/debezium/tutorial.md, docs/integrate/locust/tutorial.md	Adds article-info metadata block; locust and debezium files also receive substantial content additions including setup details, code examples, and narrative extensions.
Metadata + structural adjustments docs/integrate/node-red/mqtt-tutorial.md, docs/integrate/pandas/tutorial-start.md, docs/integrate/r/tutorial.md	Adds article-info metadata block and makes minor structural or formatting adjustments.
Timeseries documentation metadata docs/topic/timeseries/learn/query.md, docs/topic/timeseries/learn/with-metadata.md	Adds article-info metadata block with four-colon delimiters; link includes preserved.
Index reorganization docs/tutorial/index.md	Reorganizes integration references across year rubrics (2020, 2023, 2024); reallocates airflow entries and introduces new 2020 section; reflowing of grid-item card.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

The diff covers 16 files with predominantly homogeneous changes (article-info metadata insertion), reducing base complexity. However, three files include substantial content expansions (locust tutorial nearly doubled; debezium extended with narrative and code examples), and one file undergoes structural reorganization. This variety and volume necessitate review care despite the repetitive pattern.

Possibly related PRs

• crate/cratedb-guide#295: Directly modifies docs/integrate/node-red/mqtt-tutorial.md, the same file receiving article-info metadata in this PR.
• crate/cratedb-guide#293: Updates docs/integrate/locust/tutorial.md content and structure alongside this PR's metadata and content additions.
• crate/cratedb-guide#364: Modifies tutorial files including docs/feature/document/tutorial.md and docs/feature/search/fts/tutorial.md with overlapping content changes.

Suggested labels

guidance

Suggested reviewers

• kneth
• bmunkholm
• hammerhead

Poem

🐰 Metadata hops through the docs with flair,
Article-info blocks with author care,
Avatars dancing, timestamps aligned,
Seventeen files beautifully refined!
Organization blooms, a rabbit's delight. 🌱

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The PR title "Tutorials: Add article-info widgets to all tutorials" accurately and clearly summarizes the primary change across the changeset. The raw_summary shows that the majority of modifications add article-info metadata blocks containing author, avatar, date, read-time, and styling information to tutorial files across multiple directories. The title is specific, concise, and directly reflects this primary change without unnecessary noise or vague terminology.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.
Description Check	✅ Passed	The pull request description is directly related to the changeset. The author describes the intention to add article metadata (authorship, creation date, and reading time) to tutorial pages, similar to Discourse. The actual changes consistently add article-info metadata blocks across 16 tutorial and documentation files throughout the repository, which aligns perfectly with the stated objective. The description provides clear context, includes preview links demonstrating the feature in action on pages being modified, and conveys meaningful information about the changes.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch article-info

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[hammerhead]

I'm somewhat undecided yet on that change. On the one hand, it is nice to acknowledge an author and give them recognition. It feels more human to a reader. On the other hand, from a maintenance perspective, it may look like a certain page is "owned" by an individual, maybe not inviting others to edit and improve over time (making changes that appear under a different name). The documentation feels like a blog with an author and date.

[amotl]

Reply

@hammerhead: It's true, it's a dilemma. However, we should get over the thinking that contributions are not welcome (they are always!) and stop obsessing about ownership in the wrong way (possession vs. responsibility), but appreciate the other benefits you've enumerated instead: Content attributions give the content a human touch, a reference to its author, and even the possibility to reach out to them to talk about relevant topics when applicable, even if a content piece has been converged from a community post into a real article ¹.

On the author hand, the author can easily use relevant content as a reference about their work, probably piling it up into a list of links pointing to our premises, optimally published on a site with a good web rank reputation, so it encourages networking effects in both directions.

The CrateDB Guide is open to accompany all sorts of content and ideas well, without adhering too strictly to a certain paradigm or policy unilaterally. In this spirit, I think it will be a good partner going forward after absorbing all the content pieces from the community forum. Having them all in one place is incredible powerful from both an authoring/maintenance/curation and a reading/exploration/learning perspective.

• Consolidate Integration Guides I vs. II #102

Thoughts

[...] feels like a blog with an author and date.

[...] without adhering too strictly to a certain paradigm or policy unilaterally [...]

In this spirit, I think it is okay if certain documents are different than others, in character or type or layout, no matter where they are located within the content tree. Starting to exercise this in form of gradually adding article metadata at the top of the page like other authors are doing it, is a good idea to quickly inform the reader about what can be expected: The "estimated reading time" indicator follows the same idea about informing the dear reader upfront, so we might expand on this idea even more when there are no strong objections against it.

Following this rationale, the CrateDB Guide (Handbook) will easily be able to host documents bearing either reference document characteristics, howto/tutorial shapes, or blog styles.

• Diátaxis - a systematic approach to technical documentation authoring #335

Footnotes

1. This always decreases the ability to contribute by just adding a comment to the article. However, c'est la vie; future iterations might connect the documentation with the community forum again. ↩

[amotl]

[...] inform about authorship, creation date, and reading time [...]

Independently of my elaborations above, the main reason for this patch was to indicate creation/update time on relevant articles that have been absorbed from the community forum, to also convey to the reader what they can expect. While the Howtos & Tutorials landing pages will group the content by year, readers on a different navigation path wouldn't be informed well.

• https://cratedb.com/docs/guide/howto/
• https://cratedb.com/docs/guide/tutorial/

So, if you think the reference to the original author should be removed, just retaining timestamp and reading time information, let us know.