Conversation
DOCS-2697
✅ Deploy Preview for calico-docs-preview-next ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview succeeded!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
This PR substantially rewrites the README.md to provide a more comprehensive and professionally structured documentation guide for the Calico & Tigera documentation repository. The update transforms the README from a basic getting-started guide into a complete reference that covers the repository's structure, development workflows, testing practices, and deployment processes.
Changes:
- Complete restructuring with table of contents, visual branding (logo and badges), and organized sections
- Expanded documentation of the versioning model, explaining the distinction between versioned and unversioned directories
- Detailed build and development commands with both native and containerized options
- Comprehensive coverage of testing infrastructure (Jest unit tests, Playwright screenshot tests, link checking)
- Added sections on linting/style (Vale, Prettier), CI/CD workflows, operator API documentation, troubleshooting, and contribution guidelines
- Enhanced explanations of multi-product documentation flow (OSS → Enterprise → Cloud)
|
|
||
| ```bash | ||
| make autogen | ||
| make vale PRODUCT=calico |
There was a problem hiding this comment.
The vale command example is missing a required PRODUCT variable. Based on the Makefile (line 363), the vale target requires a PRODUCT environment variable to be set. The command should specify which product to check (e.g., make vale PRODUCT=calico, make vale PRODUCT=calico-enterprise, or make vale PRODUCT=calico-cloud).
|
|
||
| | Command | Description | | ||
| |---|---| | ||
| | `make init` | Install dependencies (enables Corepack, runs `yarn install`) | |
There was a problem hiding this comment.
The description "Install dependencies (enables Corepack, runs yarn install)" is not entirely accurate for native builds. Looking at the Makefile (lines 103-117), the init target only runs yarn install for native builds - it does not explicitly call corepack enable. The README correctly mentions that users must run corepack enable manually before yarn commands (line 45, line 55), but this table entry suggests that make init handles it automatically, which could be misleading. Consider clarifying that Corepack must be enabled separately before running make init for native builds, or that the init target only enables Corepack when using containerized builds.
DOCS-2697
Product Version(s):
Issue:
Link to docs preview:
SME review:
DOCS review:
Additional information:
Merge checklist: