Skip to content

Deprecate the update-imported-docs workflow and quickstart#56525

Open
Mohamed0Mourad wants to merge 2 commits into
kubernetes:mainfrom
Mohamed0Mourad:docs-retire-imported-docs-56385
Open

Deprecate the update-imported-docs workflow and quickstart#56525
Mohamed0Mourad wants to merge 2 commits into
kubernetes:mainfrom
Mohamed0Mourad:docs-retire-imported-docs-56385

Conversation

@Mohamed0Mourad

@Mohamed0Mourad Mohamed0Mourad commented Jul 18, 2026

Copy link
Copy Markdown
Contributor

Description

This PR implements the deprecation and announcement phase of subtask B4 in
#56385.

The update-imported-docs workflow is obsolete, but its files and the
quickstart URL are retained temporarily so that contributors, localization
teams, and users with bookmarked links can discover the replacement guides.

This change:

  • adds a deprecation notice to every file under update-imported-docs/;
  • replaces the quickstart body with a deprecation stub that links to the
    generator-specific guides;
  • updates the reference documentation link in new-content/_index.md to point
    to /docs/contribute/generate-ref-docs/;
  • leaves generate-ref-docs/_index.md unchanged 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 --check
  • python3 scripts/linkchecker.py -n -f content/en/docs/contribute/generate-ref-docs/quickstart.md
  • python3 scripts/linkchecker.py -n -f content/en/docs/contribute/new-content/_index.md
image
  • make container-build
  • Local preview at /docs/contribute/generate-ref-docs/quickstart/
  • quickstart before
quickstarter_before - quickstart after image

Related to: #56385

Implements the deprecation and announcement phase of B4.

@kubernetes-prow

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign sayakmukhopadhyay for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@kubernetes-prow kubernetes-prow Bot added language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Jul 18, 2026
@netlify

netlify Bot commented Jul 18, 2026

Copy link
Copy Markdown

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit c44769c
🔍 Latest deploy log https://app.netlify.com/projects/kubernetes-io-main-staging/deploys/6a5e5e6ec7a7f20008d959eb
😎 Deploy Preview https://deploy-preview-56525--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@Caesarsage Caesarsage left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for taking this on, @Mohamed0Mourad , retiring update-imported-docs.py is the right direction. Two suggestion:

  1. 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.

  2. 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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's do this for all the file on this folder instead of direct removal

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As as the comment on the README, let's deprecate first

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no need for rewrite, it will become a duplicate. we are deprecating this, so a deprecate notice will be suitable instead

@kubernetes-prow kubernetes-prow Bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Jul 20, 2026
@Mohamed0Mourad Mohamed0Mourad changed the title Retire the update-imported-docs workflow Deprecate the update-imported-docs workflow and quickstart Jul 20, 2026
@Mohamed0Mourad

Copy link
Copy Markdown
Contributor Author

@Caesarsage
Thanks for the detailed review. I narrowed the PR to the deprecation and
announcement phase:

  • restored all files under update-imported-docs/ and added deprecation notices;
  • replaced the quickstart workflow rewrite with a deprecation stub;
  • retargeted the new-content link to /docs/contribute/generate-ref-docs/;
  • left generate-ref-docs/_index.md unchanged.

The actual file removal and quickstart alias will be handled in a follow-up PR.
I also rebuilt and previewed the page locally and reran the link checks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants