Documentation with Efficient Downstreaming in Mind
summary
Automated downstreaming for Eclipse Che turns modular AsciiDoc content into two product outputs by running a filter script that converts upstream assemblies and includes, replaces project-specific strings with attributes, and cherry-picks larger chunks that need manual edits. The workflow uses Jinja templating, generated master files, CI-run containers to validate builds, and editor-integrated linters so failures surface early instead of after thousands of lines. automated downstreaming, AsciiDoc includes and attributes, CI containers and linting
AI-written summary · about
chapters (9)
- 0:00Start
- 9:16BUILD DOCS, VALIDATE LINKS
- 10:24DOWNSTREAMING FILTERS
- 11:23RUNNING FILTERS
- 12:50GENERATING THE OUTLINE
- 13:29EXCERPT FROM UPSTREAM OUTLINE
- 17:10STATIC OUTLINE
- 18:31SED, DOWNSTREAM
- 20:02ENFORCE ATTRIBUTES UPSTREAM
related talks
46mAsciidoctor: because writing docs does not have to suck
44mPushing documentation (so it doesn't hurt anymore)
47mDocumentation as code (explained to my dad)
01h 00mLevels of Docs as Code
41mStop making fool of yourself about documentation
50mContinuous and Automated Documentation Docs As Code in Practice
37mCode the documentation instead of documenting the code
29mAsciidoctor: New, Noteworthy, and Beyond