You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: COVERS.md
+11-13Lines changed: 11 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -92,26 +92,24 @@ Create an isometric illustration of ascending staircases/platforms representing
92
92
93
93
Illustrate a horizontal timeline showing the billing cycle: usage events flowing in continuously, aggregation checkpoints, end-of-period invoice generation, and payment processing. Each stage represented as a distinct station on the timeline with appropriate iconography. Style: timeline infographic, process visualization, dark theme with accent colors for each stage, modern fintech aesthetic, 16:9 aspect ratio.
title: "API Versioning: Deprecation Without Breaking Consumers"
97
+
### Prompt 1: Broken Sync Chain
98
98
99
-
### Prompt 1: Version Branches Diverging
99
+
Create a visualization of a sync process as a chain of connected gears. Most gears are turning smoothly (green glow), but one gear is jammed/broken (red glow, sparks), causing downstream gears to stop. Labels on gears show sync phases (PreSync, Sync, PostSync). Style: mechanical/industrial illustration, dark background with metallic textures, dramatic lighting on the broken gear, 16:9 aspect ratio.
100
100
101
-
Create an illustration of a single path (representing an API) that branches into multiple diverging roads labeled v1, v2, v3. The v1 road is fading/becoming overgrown (deprecated), v2 is a well-maintained highway (current), and v3 is under construction (preview). Signposts show sunset dates and migration directions. Style: stylized map/journey illustration, warm earth tones with blue accents, bird's eye view perspective, 16:9 aspect ratio.
101
+
### Prompt 2: GitOps Pipeline Obstruction
102
102
103
-
### Prompt 2: Version Lifecycle State Machine
103
+
Illustrate a pipeline carrying Git commits (represented as glowing packages) toward a Kubernetes cluster. The pipeline has a blockage/obstruction point where packages are backing up. A diagnostic panel shows error messages. Style: pipeline/plumbing visualization, tech-industrial aesthetic, blue-green color scheme with red warning indicators, cross-section view, 16:9 aspect ratio.
104
104
105
-
Design a visualization of the API version lifecycle as interconnected glowing nodes: Preview (blue/experimental), Stable (green/solid), Deprecated (amber/warning), Sunset (red/fading). Animated particle flows show versions transitioning between states. Dark background with neon-style glowing connections. Style: abstract state machine visualization, tech-forward aesthetic, dark mode with vibrant state colors, 16:9 aspect ratio.
105
+
### Prompt 3: Dependency Graph Tangle
106
106
107
-
### Prompt 3: Migration Bridge Construction
107
+
Design an abstract visualization of a resource dependency graph with some nodes connected properly (green lines) and others with broken/missing connections (red dashed lines). The tangled center represents the complexity hidden by GitOps. Style: network graph visualization, dark background, nodes as glowing orbs, connection lines with varying opacity, 16:9 aspect ratio.
108
108
109
-
Illustrate engineers building a bridge from an old API platform (v1, showing wear) to a new modern platform (v2, clean and bright). Some traffic (data packets/consumers) is already crossing, others are waiting on the v1 side. Construction cranes represent migration tooling. Style: isometric illustration, construction meets technology, warm to cool color transition left to right, 16:9 aspect ratio.
109
+
### Prompt 4: ArgoCD Dashboard Warning State
110
110
111
-
### Prompt 4: Sunset Header Beacon
111
+
Create a stylized ArgoCD-inspired dashboard interface showing an application in degraded state. Multiple sync waves displayed as horizontal tracks, with one track showing a stuck/failed resource. Warning indicators and error messages visible. Style: UI/dashboard illustration, dark mode interface, status indicator colors (red, yellow, green), modern DevOps aesthetic, 16:9 aspect ratio.
112
112
113
-
Create a lighthouse scene where the lighthouse beam sweeps over an API landscape, illuminating deprecated endpoints with warning light. Ships (consumers) navigate toward the newer, well-lit harbor (v2). The sunset colors in the sky reinforce the "sunset" theme. Style: nautical meets tech, dramatic sunset lighting, warm orange/purple sky gradient, beacon light cutting through, 16:9 aspect ratio.
113
+
### Prompt 5: Debugging Detective Scene
114
114
115
-
### Prompt 5: Version Timeline Evolution
116
-
117
-
Design a horizontal timeline showing API version evolution as geological strata or tree rings. Oldest versions (v1) at the bottom/center showing fossil-like imprints, current version (v2) as the active growing layer, future version (v3) as emerging growth. Cross-section view reveals the layered history. Style: natural history meets technology, earth tones with tech highlights, scientific illustration aesthetic, 16:9 aspect ratio.
115
+
Illustrate a detective/investigator silhouette examining a complex Kubernetes cluster diagram with a magnifying glass. The magnifying glass reveals hidden sync issues within the cluster. Clues (log snippets, error codes) scattered around. Style: noir detective meets tech, dramatic shadows, blue and amber accent lighting, investigative atmosphere, 16:9 aspect ratio.
Copy file name to clipboardExpand all lines: _TODO.md
+10-2Lines changed: 10 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -172,11 +172,17 @@ To overlay an article title and published date on a cover image, use CSS positio
172
172
- Add 'featured' to tags to filter, and move tags page to articles
173
173
- Need to make tables responsive on mobile
174
174
- Investigate why we're getting hyphenate breaks within words across lines, like or- ders and us- age
175
+
- Need to remove automatic abbr handling when the abbreviation is used in a header, also the abbr presentation needs improved - right now it gives a question mark pointer and long delay to appear
176
+
- When adding backticks in a callout, it gets the standard grey background for a code block in light theme. But it should get an offset of the callout color, like "info-offset".
177
+
- Inline code blocks are not wrapping. They're breaking to a new line. An example is in the "Scenario: CRD Sync Order Problem" section of argocd-sync-failures-gitops-debugging-troubleshooting#specific-failure-scenarios.
175
178
176
179
## Project Stuff
177
180
178
181
- Need to allow escaping a code fence inside a markdown code fence, see src/content/articles/api-gateway-metrics-traces-logs-debugging/index.mdx "Latency Spike Investigation" section and the demo article.
179
182
- I aliased 'promql' to 'go'. When a code fence using the alias is rendered with the language set to 'promql', it shows as 'go' incorrectly because of the alias. Also we need custom handling for all language names that are displayed: html should be uppercase, typescript as TypeScript, etc. Also we don't want all aliased names to show the alias - for example using the aliases 'ts', 'js', and 'md' would be better to show the full language names.
183
+
- The "go" language code block in src/content/articles/api-versioning-deprecation-sunset-headers-migration/index.mdx is not being combined with the "typescript", "python", and "ruby" tabbed code block.
184
+
- Add people who sign up for newsletter, download, or fill out contact form to Hubspot tracking. Need to configure it to remove them if they do the GDPR remove me. Also remove them from the newsletter.
185
+
- The title for a code block with yaml as the language type in "Sync wave annotations controlling resource application order" section of src/content/articles/argocd-sync-failures-gitops-debugging-troubleshooting/index.mdx is not displaying, it's showing the YAML language tag instead of the title. Also, the word "app" is being highlighted for some reason in this code block.
180
186
181
187
## Reading position indicator
182
188
@@ -188,6 +194,8 @@ To overlay an article title and published date on a cover image, use CSS positio
188
194
- Add a QR code at the bottom of printed pages so it's easier for someone to navigate to from a printed page.
189
195
- Need a layout alternative to Markup that formats for print. It needs to handle TOC differently as a full-width page. Need a fixed cover page format that adds article title, subtitle, and date.
190
196
- We have two print scenarios: black and white, and color for PDF output. Can use two different media queries to accomplish getting colored variables.
197
+
- Generate mermaid graphs for PDF from AI image generator to improve looks.
198
+
- Need to make sure that on print, when we have a tabbed code block with multiple languages, only the first language is printed and the other language tabs are hidden.
191
199
192
200
[Paged.js](https://pagedjs.org/en/documentation/) polyfills `@page` properties, and lays out an HTML document in print format where it can have page numbers generated to update in a table of contents.
193
201
@@ -248,7 +256,7 @@ some config
248
256
\`\`\`
249
257
```
250
258
251
-
For code examples like YAML config, use a concrete tool context so readers can understand where they would deploy or use the code. A single comment line or reference to the tool, or a descriptive file name, is sufficient. Prefer showing usage for AWS but a small amount of variety showing open source tools is the optimal case. So, for example, if there were four config examples, three might apply to AWS and one to an alternative tool. It is unnecessary to give complete examples - just enough to convey what we would inform the reader of by using a generic code or config example, and an appropriate marker (like ellipses or a comment saying a cut is made) to show that the example is not complete. An explanatory paragraph is good too.
259
+
For code examples like YAML config, use a concrete tool context so readers can understand where they would deploy or use the code. A single comment line or reference to the tool, or a descriptive file name, is sufficient. Prefer showing usage for AWS but a small amount of variety showing open source tools is the optimal case. So, for example, if there were four config examples, three might apply to AWS and one to an alternative tool. Do not include multiple tables, code blocks, or mermaid diagrams in a row without text between them to break them up.
252
260
253
261
__review__
254
262
@@ -262,7 +270,7 @@ __implement_article__
262
270
263
271
I renamed our longer article to pdf.mdx and created an empty index.mdx template. Ignore the coverAlt frontmatter line that has "TODO". It will be added later when cover art is added. Use a single underscore for emphasis style, not asterisks. Use plain quotations and apostrophes, not smart quotes. Do not start the article with an H1 in the Markdown - the system automatically adds the title frontmatter key as an H1 header. Let's implement the article we just outlined. The captions for tables and other elements use a prefix like ("Table: ") to let the unified markdown pipeline know to convert this into a caption - don't worry about the prefixes, they'll be normalized later.
264
272
265
-
Add suggested text for a call to action to download the longer PDF at the bottom of the article under an HR. Do not worry about optimizing this text for the total word count of the article - it is not included in the word count since it will be used in a CTA, and I will handle deducting so there's no need to worry about complex calculations to the word count. Don't include a link in the CTA. Do not mention the word length. Do not worry about formatting - the content will be used as props for a dedicated Component.
273
+
Add suggested text for a call to action to download the longer PDF at the bottom of the article under an HR. Do not worry about optimizing this text for the total word count of the article - it is not included in the word count since it will be used in a CTA, and I will handle deducting so there's no need to worry about complex calculations to the word count. Don't include a link in the CTA. Do not mention the word length. Do not worry about formatting - the content will be used as props for a dedicated Component. Do not include multiple tables, code blocks, or mermaid diagrams in a row without text between them to break them up.
0 commit comments