|
| 1 | +# Platform Cron Documentation Improvement Checklist |
| 2 | + |
| 3 | +## 📋 Overview |
| 4 | + |
| 5 | +This checklist guides the application of our proven cron documentation improvements to all Sentry platforms. Based on our successful JavaScript platform cleanup, this ensures consistent, maintainable, and user-friendly cron monitoring documentation across all supported SDKs. |
| 6 | + |
| 7 | +**Reference Implementation:** [JavaScript Platform](https://docs.sentry.io/platforms/javascript/common/crons/) |
| 8 | +**Source:** [Sentry Crons Getting Started](https://docs.sentry.io/product/crons/getting-started/) |
| 9 | + |
| 10 | +## 🎯 Platforms to Update |
| 11 | + |
| 12 | +### ✅ Completed Platforms |
| 13 | +- [x] **JavaScript/Node.js** - ✅ **Phase 1 Complete** |
| 14 | + - [x] Next.js |
| 15 | + - [x] SvelteKit |
| 16 | + - [x] Remix |
| 17 | + - [x] NestJS |
| 18 | + |
| 19 | +### 🔄 Pending Platforms |
| 20 | + |
| 21 | +#### High-Priority SDK Platforms |
| 22 | +- [ ] **Python** |
| 23 | + - [ ] Base Python SDK |
| 24 | + - [ ] Celery integration |
| 25 | +- [ ] **PHP** |
| 26 | + - [ ] Base PHP SDK |
| 27 | + - [ ] Laravel integration |
| 28 | +- [ ] **Java** |
| 29 | + - [ ] Base Java SDK |
| 30 | + - [ ] Spring Boot integration |
| 31 | +- [ ] **Go** |
| 32 | +- [ ] **Ruby** |
| 33 | +- [ ] **Elixir** |
| 34 | + |
| 35 | +#### CLI/HTTP Methods |
| 36 | +- [ ] **HTTP Implementation** |
| 37 | +- [ ] **Sentry CLI** |
| 38 | + |
| 39 | +## 📐 Implementation Template |
| 40 | + |
| 41 | +### File Structure Template |
| 42 | +``` |
| 43 | +docs/platforms/{platform}/common/crons/ |
| 44 | +├── index.mdx # Main cron monitoring overview |
| 45 | +├── automatic.mdx # Auto-instrumentation (if supported) |
| 46 | +├── job-monitoring.mdx # Full context method |
| 47 | +├── check-ins.mdx # Heartbeat style method |
| 48 | +├── heartbeat.mdx # Simple ping method |
| 49 | +├── upserting-monitors.mdx # Programmatic monitor creation |
| 50 | +└── troubleshooting.mdx # FAQ format |
| 51 | +``` |
| 52 | + |
| 53 | +### Required Page Changes Per Platform |
| 54 | + |
| 55 | +#### 1. Main Index Page (`index.mdx`) |
| 56 | +**Current State Assessment:** |
| 57 | +- [ ] Evaluate current content length and complexity |
| 58 | +- [ ] Identify repetitive explanations |
| 59 | +- [ ] Check for overwhelming decision points |
| 60 | + |
| 61 | +**Required Updates:** |
| 62 | +- [ ] Simplify integration path presentation |
| 63 | +- [ ] Remove verbose explanations |
| 64 | +- [ ] Clear categorization: UI Setup → Automatic → Manual Methods |
| 65 | +- [ ] Remove repetitive notes about CLI/HTTP limitations |
| 66 | +- [ ] Ensure working platform-specific examples |
| 67 | + |
| 68 | +**Content Structure:** |
| 69 | +```markdown |
| 70 | +# Cron Monitoring |
| 71 | + |
| 72 | +Brief intro to cron monitoring for {platform}. |
| 73 | + |
| 74 | +## Integration Methods |
| 75 | + |
| 76 | +### UI Setup |
| 77 | +[Platform-agnostic description with link to UI setup guide] |
| 78 | + |
| 79 | +### Automatic Integration |
| 80 | +[Platform-specific auto-instrumentation if available] |
| 81 | + |
| 82 | +### Manual Methods |
| 83 | +[Link to the four manual approaches] |
| 84 | + |
| 85 | +[Platform-specific getting started example] |
| 86 | +``` |
| 87 | + |
| 88 | +#### 2. Automatic Integration (`automatic.mdx`) |
| 89 | +**Platform Capability Assessment:** |
| 90 | +- [ ] **Full Auto-instrumentation:** Platform has popular cron libraries that can be auto-instrumented |
| 91 | +- [ ] **Limited Support:** Some libraries supported, link to manual methods for others |
| 92 | +- [ ] **No Support:** Platform doesn't have auto-instrumentation, redirect to manual methods |
| 93 | + |
| 94 | +**Required Updates:** |
| 95 | +- [ ] Platform-specific library detection and instrumentation |
| 96 | +- [ ] Clear "when to use" guidance |
| 97 | +- [ ] Working code examples for supported libraries |
| 98 | +- [ ] Links to manual methods for unsupported cases |
| 99 | + |
| 100 | +#### 3. Manual Method Pages |
| 101 | +**Apply to All Four Methods:** |
| 102 | +- [ ] `job-monitoring.mdx` |
| 103 | +- [ ] `check-ins.mdx` |
| 104 | +- [ ] `heartbeat.mdx` |
| 105 | +- [ ] `upserting-monitors.mdx` |
| 106 | + |
| 107 | +**Content Reduction Requirements:** |
| 108 | +- [ ] **Target Length:** 50-80 lines (down from 200+ lines) |
| 109 | +- [ ] **Structure:** Purpose → When to Use → Quick Example → Reference Links |
| 110 | +- [ ] **Remove:** Verbose explanations, repeated setup instructions |
| 111 | +- [ ] **Keep:** Essential usage patterns, working code examples |
| 112 | + |
| 113 | +**Platform-Specific Code Examples:** |
| 114 | +- [ ] Verify all code examples work with current SDK version |
| 115 | +- [ ] Use platform-appropriate syntax and conventions |
| 116 | +- [ ] Include necessary imports and setup |
| 117 | +- [ ] Remove placeholders where possible (use real values) |
| 118 | + |
| 119 | +#### 4. Troubleshooting (`troubleshooting.mdx`) |
| 120 | +**Convert from Narrative to FAQ:** |
| 121 | +- [ ] **Current Assessment:** Identify verbose troubleshooting content |
| 122 | +- [ ] **Target Structure:** 4-6 key FAQ items maximum |
| 123 | +- [ ] **Platform-Specific Issues:** Include platform-specific troubleshooting |
| 124 | +- [ ] **Support Navigation:** Include "Getting Help" section with links |
| 125 | + |
| 126 | +**FAQ Structure Template:** |
| 127 | +```markdown |
| 128 | +# Troubleshooting |
| 129 | + |
| 130 | +## Common Issues |
| 131 | + |
| 132 | +### Issue 1: [Platform-specific problem] |
| 133 | +**Problem:** [Brief description] |
| 134 | +**Solution:** [Actionable fix] |
| 135 | + |
| 136 | +### Issue 2: [Configuration problem] |
| 137 | +**Problem:** [Brief description] |
| 138 | +**Solution:** [Actionable fix] |
| 139 | + |
| 140 | +### Issue 3: [Monitoring not working] |
| 141 | +**Problem:** [Brief description] |
| 142 | +**Solution:** [Actionable fix] |
| 143 | + |
| 144 | +### Issue 4: [Performance/integration issue] |
| 145 | +**Problem:** [Brief description] |
| 146 | +**Solution:** [Actionable fix] |
| 147 | + |
| 148 | +## Getting Help |
| 149 | +[Links to support, platform-specific documentation, etc.] |
| 150 | +``` |
| 151 | + |
| 152 | +#### 5. Content Cleanup |
| 153 | +**Remove Advanced Configuration Pages:** |
| 154 | +- [ ] Assess if platform has "advanced" configuration pages |
| 155 | +- [ ] **Decision:** Remove entirely (following JavaScript precedent) |
| 156 | +- [ ] **Reason:** Users feedback indicated these were "overkill" |
| 157 | +- [ ] Update all links that referenced advanced pages |
| 158 | + |
| 159 | +**Link Management:** |
| 160 | +- [ ] Verify all internal links work after page removal |
| 161 | +- [ ] Update sidebar navigation order |
| 162 | +- [ ] Fix any broken cross-references |
| 163 | +- [ ] Test dev server for 404 errors |
| 164 | + |
| 165 | +## 🔧 Platform-Specific Considerations |
| 166 | + |
| 167 | +### High Auto-Instrumentation Platforms |
| 168 | +**Platforms:** Node.js, Python |
| 169 | +- [ ] Emphasize automatic integration as preferred method |
| 170 | +- [ ] Provide clear library support matrix |
| 171 | +- [ ] Include migration guidance from manual to automatic |
| 172 | + |
| 173 | +### Limited Auto-Instrumentation Platforms |
| 174 | +**Platforms:** PHP, Java, others |
| 175 | +- [ ] Focus on manual methods as primary approach |
| 176 | +- [ ] Include auto-instrumentation for supported libraries where available |
| 177 | +- [ ] Clear guidance on when manual methods are needed |
| 178 | + |
| 179 | +### CLI/HTTP Only Platforms |
| 180 | +**Platforms:** Generic HTTP, CLI usage |
| 181 | +- [ ] Acknowledge SDK feature limitations upfront |
| 182 | +- [ ] Focus on the available functionality |
| 183 | +- [ ] Clear setup instructions specific to CLI/HTTP approach |
| 184 | + |
| 185 | +## 📊 Quality Assurance Checklist |
| 186 | + |
| 187 | +### Content Quality |
| 188 | +- [ ] **Length Target:** 50-80 lines per manual method page |
| 189 | +- [ ] **Duplication:** No repeated content across pages |
| 190 | +- [ ] **Examples:** All code examples tested and working |
| 191 | +- [ ] **Links:** All internal links verified and functional |
| 192 | +- [ ] **Style:** Follows established [content strategy](./llms/content-strategy.mdc) |
| 193 | + |
| 194 | +### User Experience |
| 195 | +- [ ] **Clear Path:** Obvious route from problem to solution |
| 196 | +- [ ] **Decision Support:** Guidance on which method to choose |
| 197 | +- [ ] **Progressive Disclosure:** Advanced topics linked, not inline |
| 198 | +- [ ] **Cognitive Load:** Reduced overwhelming options |
| 199 | + |
| 200 | +### Technical Validation |
| 201 | +- [ ] **SDK Compatibility:** Examples work with current SDK version |
| 202 | +- [ ] **Import Statements:** All necessary imports included |
| 203 | +- [ ] **Error Handling:** Basic error handling shown where relevant |
| 204 | +- [ ] **Configuration:** Links to detailed configuration docs |
| 205 | + |
| 206 | +### Navigation & Structure |
| 207 | +- [ ] **Sidebar Order:** Logical progression through integration methods |
| 208 | +- [ ] **Breadcrumbs:** Clear hierarchical navigation |
| 209 | +- [ ] **Cross-References:** Helpful links between related methods |
| 210 | +- [ ] **Mobile:** Responsive design and readable on mobile devices |
| 211 | + |
| 212 | +## 🚀 Implementation Process |
| 213 | + |
| 214 | +### Phase 1: Platform Assessment (Week 1) |
| 215 | +1. **Content Audit** |
| 216 | + - [ ] Document current page lengths and structure |
| 217 | + - [ ] Identify duplicate content across methods |
| 218 | + - [ ] List platform-specific auto-instrumentation capabilities |
| 219 | + - [ ] Note current user pain points or support issues |
| 220 | + |
| 221 | +2. **Platform Capability Matrix** |
| 222 | + - [ ] Auto-instrumentation support level |
| 223 | + - [ ] Available manual methods for platform |
| 224 | + - [ ] SDK version and compatibility requirements |
| 225 | + - [ ] Platform-specific integration patterns |
| 226 | + |
| 227 | +### Phase 2: Content Restructuring (Week 2) |
| 228 | +1. **Apply Content Reduction** |
| 229 | + - [ ] Implement essential-first structure on all pages |
| 230 | + - [ ] Remove verbose explanations and duplicate content |
| 231 | + - [ ] Update code examples for platform syntax |
| 232 | + - [ ] Convert troubleshooting to FAQ format |
| 233 | + |
| 234 | +2. **Update Information Architecture** |
| 235 | + - [ ] Clear method categorization |
| 236 | + - [ ] Progressive disclosure implementation |
| 237 | + - [ ] Cross-reference optimization |
| 238 | + - [ ] Navigation flow improvement |
| 239 | + |
| 240 | +### Phase 3: Validation & Testing (Week 3) |
| 241 | +1. **Technical Validation** |
| 242 | + - [ ] Test all code examples |
| 243 | + - [ ] Verify link functionality |
| 244 | + - [ ] Check sidebar navigation |
| 245 | + - [ ] Mobile responsiveness check |
| 246 | + |
| 247 | +2. **Content Review** |
| 248 | + - [ ] Style guide compliance |
| 249 | + - [ ] Platform-specific accuracy |
| 250 | + - [ ] User experience flow |
| 251 | + - [ ] Support team review (if applicable) |
| 252 | + |
| 253 | +## 📈 Success Metrics |
| 254 | + |
| 255 | +### Quantitative Measures |
| 256 | +- [ ] **Content Length Reduction:** Target 60% reduction in page length |
| 257 | +- [ ] **Duplicate Content Elimination:** Zero repeated content across methods |
| 258 | +- [ ] **Link Health:** 100% working internal links |
| 259 | +- [ ] **Code Example Coverage:** All examples tested and functional |
| 260 | + |
| 261 | +### Qualitative Measures |
| 262 | +- [ ] **User Journey Clarity:** Clear path from problem to solution |
| 263 | +- [ ] **Method Selection:** Obvious guidance on which approach to use |
| 264 | +- [ ] **Cognitive Load Reduction:** Less overwhelming decision making |
| 265 | +- [ ] **Maintenance Efficiency:** Easier to maintain and update |
| 266 | + |
| 267 | +## 🔄 Platform Rollout Schedule |
| 268 | + |
| 269 | +### Immediate Priority (Q1) |
| 270 | +1. **Python** - High usage, good auto-instrumentation support |
| 271 | +2. **PHP** - High usage, Laravel integration important |
| 272 | +3. **Java** - Enterprise focus, Spring Boot integration |
| 273 | + |
| 274 | +### Secondary Priority (Q2) |
| 275 | +4. **Go** - Growing adoption, manual methods focus |
| 276 | +5. **Ruby** - Established user base |
| 277 | +6. **Elixir** - Smaller but dedicated user base |
| 278 | + |
| 279 | +### Final Priority (Q3) |
| 280 | +7. **HTTP Documentation** - Language-agnostic approach |
| 281 | +8. **CLI Documentation** - Developer tooling focus |
| 282 | + |
| 283 | +## 📝 PR Template for Each Platform |
| 284 | + |
| 285 | +```markdown |
| 286 | +# Unified Cron Monitoring Experience - {Platform} Platform |
| 287 | + |
| 288 | +## Summary |
| 289 | +Applies proven documentation improvements from JavaScript platform to {Platform} cron monitoring docs. |
| 290 | + |
| 291 | +## Changes |
| 292 | +- ✅ Reduced page length by ~60% (from X to Y lines average) |
| 293 | +- ✅ Eliminated duplicate content across methods |
| 294 | +- ✅ Applied essential-first content structure |
| 295 | +- ✅ Updated all code examples for {Platform} syntax |
| 296 | +- ✅ Converted troubleshooting to FAQ format |
| 297 | +- ✅ [Platform-specific improvements] |
| 298 | + |
| 299 | +## Testing |
| 300 | +- [x] All code examples tested and working |
| 301 | +- [x] Internal links verified |
| 302 | +- [x] Sidebar navigation optimized |
| 303 | +- [x] Mobile responsiveness confirmed |
| 304 | + |
| 305 | +**Follows:** [Content Strategy Framework](.cursor/rules/llms/content-strategy.mdc) |
| 306 | +**Reference:** JavaScript platform implementation |
| 307 | +``` |
| 308 | + |
| 309 | +## 🤝 Cross-Platform Consistency |
| 310 | + |
| 311 | +### Shared Content Opportunities |
| 312 | +- [ ] **UI Setup Instructions:** Can be largely platform-agnostic |
| 313 | +- [ ] **Troubleshooting Patterns:** Many issues are cross-platform |
| 314 | +- [ ] **Method Selection Guidance:** Decision criteria often similar |
| 315 | +- [ ] **Configuration References:** Link to platform-specific config docs |
| 316 | + |
| 317 | +### Platform-Specific Elements |
| 318 | +- [ ] **Code Syntax:** Platform-appropriate examples and imports |
| 319 | +- [ ] **Library Integrations:** Platform-specific auto-instrumentation |
| 320 | +- [ ] **Performance Considerations:** Platform-specific optimization notes |
| 321 | +- [ ] **Deployment Notes:** Platform-specific deployment considerations |
| 322 | + |
| 323 | +--- |
| 324 | + |
| 325 | +This checklist ensures consistent application of our proven cron documentation improvements across all Sentry platforms while respecting platform-specific needs and capabilities. |
0 commit comments