Migration Checklist:
Migration Challenges:
- Most should be easy copy and paste MD and it works. But MDX which contain some React components which need to fix import path.
- Docs structure: the old docs do not have Subsection. In the new docs we introduce new subsection. However, VJ pointed out we should keep the same URL because it’s already indexed by Google.
- We can redirect the old url to new one (Example: https://app.graphite.dev/github/pr/statsig-io/docs-v2/54/Redirect-Example (opens in a new tab))
- Migrate Docusaurus built-in component to Nextra built-in compoents. Some docs use built-in component that needs update like Call out section. Example (https://nextra.site/docs/guide/built-ins/callout (opens in a new tab))
- These are already resolved by plugins
Migration Plan:
The complexity of migrating these Docs over depend on the content. I identify the 3 most complexed parts and assigned to engineers already. If you have any problem with certain content, please log it directly down here and one of the engineers can take a look.
- Intro (opens in a new tab)
- Copy the docs (opens in a new tab)
- Ordering and naming the docs (opens in a new tab)
Example PR: https://app.graphite.dev/github/pr/anle-statsig/docs-v2/30/Add-Product-Analytics (opens in a new tab)
Use the built-in component: https://nextra.site/docs/guide/built-ins (opens in a new tab)
Whatever you cannot import please put it under the section you are working on. One of the engineers will import them later.
- Getting Started (opens in a new tab) @Candice Chow
- Guides
- Advanced Walkthrough Guides
- Developer Guides
- Technology Specific Guides
- Feature Flags (opens in a new tab)
- Experimentation @An Le
- Product Analytics @An Le (opens in a new tab)
- Statsig Warehouse Native (opens in a new tab)
- Session Replay (opens in a new tab)
- Web Analytics (opens in a new tab)
- SDKs, APIs, Integration (opens in a new tab)
- Getting Started (opens in a new tab)
- Client SDKs (opens in a new tab) @Jairo Garciga
- Server SDKs (opens in a new tab) @Jairo Garciga
- HTTP API (opens in a new tab)
- Console API (opens in a new tab) @An Le
- Integrations (opens in a new tab) @Brian Do
- Data Warehouse Ingestion (opens in a new tab) @Brian Do
- Notices (opens in a new tab)
- Admin (opens in a new tab)