Deprecate the update-imported-docs workflow and quickstart#56525
Deprecate the update-imported-docs workflow and quickstart#56525Mohamed0Mourad wants to merge 2 commits into
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
✅ Pull request preview available for checkingBuilt without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
Caesarsage
left a comment
There was a problem hiding this comment.
Thanks for taking this on, @Mohamed0Mourad , retiring update-imported-docs.py is the right direction. Two suggestion:
-
Deprecate, don't delete: both the update-imported-docs/ files and quickstart.md. Nothing in CI or tooling invokes the script, so this is signposting (localization teams, bookmarked URLs) rather than a hard dependency, but deprecate → announce → remove is safer. Add a deprecation notice to each update-imported-docs/ file, and replace the quickstart.md body with a deprecation stub that links the per-generator pages. A follow-up PR removes both, with aliases: for the quickstart URL.
-
Drop the quickstart workflow rewrite. The reference docs are generated one page per generator now (kubernetes-api.md, config-api.md in #56497, the merging of component page in B1), so re-inlining the pipeline here duplicates them and the page is being deprecated anyway.
Also leave the generate-ref-docs/_index.md alone too; turning it into the section entry point is subtask B3.
Scope for this PR: deprecate update-imported-docs/ + deprecate quickstart.md, and retarget the new-content/_index.md link you already changed to the section index (/docs/contribute/generate-ref-docs/) instead of the quickstart.
The module map and the actual removals come with B3 and a cleanup PR.
There was a problem hiding this comment.
IMO, we should add a deprecation note here first before deleting the file. This is the flow i generally follow
Deprecate -> Announce -> Wait -> Remove (if needed)
The first PR will serve as (Deprecate and Announce ). Then we could raise another PR to remove the file (referencing this after merged).
There was a problem hiding this comment.
Let's do this for all the file on this folder instead of direct removal
There was a problem hiding this comment.
Done. I restored all four files under update-imported-docs/ and added a clear
deprecation notice to each file. No workflow files are removed in this PR now.
There was a problem hiding this comment.
As as the comment on the README, let's deprecate first
There was a problem hiding this comment.
Done. I restored reference.yml and marked it as deprecated. I applied the same
notice to release.yml and update-imported-docs.py as requested.
There was a problem hiding this comment.
no need for rewrite, it will become a duplicate. we are deprecating this, so a deprecate notice will be suitable instead
|
@Caesarsage
The actual file removal and quickstart alias will be handled in a follow-up PR. |
Description
This PR implements the deprecation and announcement phase of subtask B4 in
#56385.
The
update-imported-docsworkflow is obsolete, but its files and thequickstart URL are retained temporarily so that contributors, localization
teams, and users with bookmarked links can discover the replacement guides.
This change:
update-imported-docs/;generator-specific guides;
new-content/_index.mdto pointto
/docs/contribute/generate-ref-docs/;generate-ref-docs/_index.mdunchanged for subtask B3.No workflow files or documentation URLs are removed in this PR. Their removal,
including an alias for the quickstart URL, will be handled in a follow-up PR.
Validation
git diff --cached --checkpython3 scripts/linkchecker.py -n -f content/en/docs/contribute/generate-ref-docs/quickstart.mdpython3 scripts/linkchecker.py -n -f content/en/docs/contribute/new-content/_index.mdmake container-build/docs/contribute/generate-ref-docs/quickstart/Related to: #56385
Implements the deprecation and announcement phase of B4.