influxdata / influxdata/docs-v2
products.yml changes should trigger validation of content that consumes changed values
- Dominant language
- JavaScript
- Stars
- 82
- Forks
- 326
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 82
Description
If a PR contains `data/products.yml` changes, CI should trigger Visual Review for a page representative of the changed product(s).
## Details
- Changes to `data/products.yml` should always trigger a Visual Review. Even if the PR doesn't change any `content/` files, CI should preview a page that uses the edited properties.
- For example, if the PR bumps `latest_patch` for a product, CI should trigger Preview and Visual Review for a page that uses `latest_patch` (`latest-patch` shortcode is commonly used in install and get-started pages).
Example: https://github.com/influxdata/docs-v2/pull/7070/checks?check_run_id=70251519110
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by tracing the CI workflow that handles Visual Review and how changes to data/products.yml are detected. Inspect the latest-patch shortcode and representative install or get-started pages. Done means a PR changing product values triggers Preview and Visual Review even without content/ changes, using the example PR checks as a reference.
Written by the indexing model from the issue text.
Assessment
- Domain
- ci-cd, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100