Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move 2 pages about new content to appropriate section #50087

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

sftim
Copy link
Contributor

@sftim sftim commented Mar 13, 2025

The moved pages were in the docs style section of our docs about contributin, but they are more more relevant as guides to new content.

  • If you have an existing page, it already has a content type set.
  • If you are writing a new topic, it is new content.

/language en
/label refactor

I made [proposed] this change to support improvements around our guide to blog contribution.

The moved pages were in the docs style section, but they are more more
relevant as guides to new content.

* If you have an existing page, it already has a content type set.
* If you are writing a new topic, it is new content.
@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language refactor Indicates a PR with large refactoring changes e.g. removes files or moves content cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Mar 13, 2025
@k8s-ci-robot
Copy link
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 ask for approval from sftim. For more information see the Code Review Process.

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

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

@k8s-ci-robot k8s-ci-robot added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label Mar 13, 2025
@k8s-ci-robot k8s-ci-robot requested a review from drewhagen March 13, 2025 19:57
@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Mar 13, 2025
Copy link

netlify bot commented Mar 13, 2025

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit 75f5a0c
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/67d33891d5fe520008fc3793
😎 Deploy Preview https://deploy-preview-50087--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 site configuration.

@sftim sftim requested a review from Copilot March 16, 2025 23:59

Choose a reason for hiding this comment

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

Pull Request Overview

This PR migrates documentation links and adjusts page ordering metadata to better reflect the separation between the legacy docs style and the new content guides for blog contribution and related topics. Key changes include:

  • Updating all references from the old style (/docs/contribute/style/page-content-types/) to the new content (/docs/contribute/new-content/page-content-types/).
  • Modifying weight values on content metadata files to adjust the ordering of new content.
  • Adjusting various navigational and helper links across multiple documentation files.

Reviewed Changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.

Show a summary per file
File Description
content/en/docs/contribute/review/reviewing-prs.md Updated link for page content type reference
content/en/docs/contribute/style/style-guide.md Updated URLs for task/tutorial templates and navigational links
content/en/docs/contribute/new-content/_index.md Updated link for page content types
content/en/docs/contribute/tutorials/_index.md Updated link for page content types
content/en/docs/contribute/new-content/page-content-types.md Adjusted weight metadata
content/en/docs/contribute/new-content/write-new-topic.md Updated link and weight metadata
content/en/docs/contribute/docs.md Updated link for page content types
content/en/docs/contribute/style/hugo-shortcodes/index.md Updated supporting navigational links
Comments suppressed due to low confidence (3)

content/en/docs/contribute/style/style-guide.md:291

  • Ensure that the anchor link (#task) in the new URL actually points to the intended section in the updated page content types document to avoid broken navigation.
in the `prerequisites` section of the [Task template](/docs/contribute/new-content/page-content-types/#task)

content/en/docs/contribute/new-content/page-content-types.md:4

  • Verify that the adjusted weight value (70) maintains the intended ordering in the navigation, as the previous value (80) may have been required for correct positioning.
weight: 70

content/en/docs/contribute/new-content/write-new-topic.md:4

  • Confirm that the new weight value (60) aligns with the desired page ordering and consistency with other related content, ensuring a smooth user experience.
weight: 60
@Ritikaa96
Copy link
Contributor

This LGTM

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 refactor Indicates a PR with large refactoring changes e.g. removes files or moves content sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants