Skip to content

Commit 3ea56b2

Browse files
committed
fix: correct platform checklist with actual completed work and add missing JS platforms
Corrections: - Clarify that Phase 1 completed Next.js, SvelteKit, Remix, NestJS (not base Node.js) - Add Node.js base patterns as completed (established during framework work) Additions: - Add missing JavaScript platforms: Koa, Hapi, Deno, Bun - Add Express for review (may have existing patterns) Special Requirements: - Add detailed Next.js + Vercel integration requirements - Specify automatic-vercel.mdx page creation - Include content structure from existing Vercel documentation - Note Pages Router vs App Router limitations Updated Rollout Schedule: - Phase 1: Complete remaining JavaScript platforms first - Phases 2-3: Continue with Python, PHP, Java, etc.
1 parent 2a8b0db commit 3ea56b2

File tree

1 file changed

+75
-11
lines changed

1 file changed

+75
-11
lines changed

.cursor/project/features/005-unified-cron-monitoring-experience/PLATFORM-CRON-DOCS-CHECKLIST.md

Lines changed: 75 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,23 @@ This checklist guides the application of our proven cron documentation improveme
1010
## 🎯 Platforms to Update
1111

1212
### ✅ Completed Platforms
13-
- [x] **JavaScript/Node.js** - ✅ **Phase 1 Complete**
14-
- [x] Next.js
13+
- [x] **JavaScript Frameworks** - ✅ **Phase 1 Complete**
14+
- [x] Next.js*Special: Needs Vercel automatic integration page*
1515
- [x] SvelteKit
1616
- [x] Remix
1717
- [x] NestJS
18+
- [x] Node.js (base patterns established)
1819

19-
### 🔄 Pending Platforms
20+
### 🔄 Pending JavaScript Platforms
21+
- [ ] **Node.js Additional Frameworks**
22+
- [ ] Koa
23+
- [ ] Hapi
24+
- [ ] Express (basic patterns may exist, needs review)
25+
- [ ] **JavaScript Runtimes**
26+
- [ ] Deno
27+
- [ ] Bun
28+
29+
### 🔄 Pending SDK Platforms
2030

2131
#### High-Priority SDK Platforms
2232
- [ ] **Python**
@@ -182,6 +192,55 @@ Brief intro to cron monitoring for {platform}.
182192
- [ ] Focus on the available functionality
183193
- [ ] Clear setup instructions specific to CLI/HTTP approach
184194

195+
### ⭐ Next.js Special Requirements - Vercel Integration
196+
197+
**Platforms:** Next.js specifically
198+
- [ ] **Create dedicated Vercel integration page** - `automatic-vercel.mdx`
199+
- [ ] **Link only from Next.js crons main page** - Not shown for other JavaScript frameworks
200+
- [ ] **Content source combination:**
201+
- [Automatic Check-Ins (Vercel Only)](https://docs.sentry.io/platforms/javascript/guides/nextjs/crons/#automatic-check-ins-vercel-only)
202+
- [Instrument Vercel Cron Jobs](https://docs.sentry.io/platforms/javascript/guides/nextjs/manual-setup/#step-6-instrument-vercel-cron-jobs-optional)
203+
204+
**Required Content Structure:**
205+
```markdown
206+
# Automatic Vercel Integration
207+
208+
Automatic cron monitoring for Next.js applications deployed on Vercel.
209+
210+
## Prerequisites
211+
- Next.js application hosted on Vercel
212+
- Vercel Cron Jobs configured in vercel.json
213+
- Pages Router (App Router not yet supported)
214+
215+
## Configuration
216+
217+
Add to your next.config.js:
218+
219+
```javascript
220+
module.exports = withSentryConfig(nextConfig, {
221+
automaticVercelMonitors: true,
222+
});
223+
```
224+
225+
## How It Works
226+
- Instrumented cron jobs decided at runtime by examining crons field in vercel.json
227+
- Automatically creates Check-Ins in Sentry
228+
- Currently supports Pages Router only
229+
230+
## Limitations
231+
- Vercel hosting required
232+
- Pages Router only (App Router route handlers not yet supported)
233+
- Requires vercel.json cron configuration
234+
```
235+
236+
**Implementation Checklist:**
237+
- [ ] Create `docs/platforms/javascript/guides/nextjs/crons/automatic-vercel.mdx`
238+
- [ ] Add link from main Next.js crons page only
239+
- [ ] Include clear prerequisites and limitations
240+
- [ ] Working code example with next.config.js
241+
- [ ] Link to Vercel cron jobs documentation
242+
- [ ] Note about Pages Router vs App Router support
243+
185244
## 📊 Quality Assurance Checklist
186245
187246
### Content Quality
@@ -266,19 +325,24 @@ Brief intro to cron monitoring for {platform}.
266325
267326
## 🔄 Platform Rollout Schedule
268327
328+
### JavaScript Platform Completion (Q1)
329+
1. **Next.js Vercel Integration** - Create automatic-vercel.mdx page
330+
2. **Node.js Frameworks** - Koa, Hapi, Express (review needed)
331+
3. **JavaScript Runtimes** - Deno, Bun
332+
269333
### 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
334+
4. **Python** - High usage, good auto-instrumentation support
335+
5. **PHP** - High usage, Laravel integration important
336+
6. **Java** - Enterprise focus, Spring Boot integration
273337
274338
### 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
339+
7. **Go** - Growing adoption, manual methods focus
340+
8. **Ruby** - Established user base
341+
9. **Elixir** - Smaller but dedicated user base
278342
279343
### Final Priority (Q3)
280-
7. **HTTP Documentation** - Language-agnostic approach
281-
8. **CLI Documentation** - Developer tooling focus
344+
10. **HTTP Documentation** - Language-agnostic approach
345+
11. **CLI Documentation** - Developer tooling focus
282346
283347
## 📝 PR Template for Each Platform
284348

0 commit comments

Comments
 (0)