Restructure and consolidate information in Contribute section by celestehorgan · Pull Request #19576 · kubernetes/website

celestehorgan · 2020-03-09T19:46:39Z

Address feedback in this conversation
Fix links

This is a re-opening of PR #19109.

Closes #19108. See also: #18878

This PR replaces the Start Contributing and Intermediate pages into topic/task-based subject areas. It also aims to reduce duplication of content that occurred between these pages. It was closed to a better branching strategy on my part, to fix some merge conflicts, and to

It's a big PR that's already had considerable content review in the original PR, and still has a bit of work to go.

celestehorgan · 2020-03-09T19:52:12Z

Note: I couldn't find a reasonable home/place for the changes in ead3e36 – any suggestions?

netlify · 2020-03-09T19:57:40Z

Deploy preview for kubernetes-io-master-staging ready!

Built with commit f0cded0

https://deploy-preview-19576--kubernetes-io-master-staging.netlify.com

celestehorgan · 2020-03-09T20:02:39Z

/do-not-merge work-in-progress

sftim · 2020-03-10T00:40:35Z

To mark this as WIP, I will:
/retitle [WIP] Restructure and consolidate information in Contribute section

celestehorgan · 2020-03-10T15:46:36Z

/remove-work-in-progress

celestehorgan · 2020-03-10T15:49:33Z

content/en/docs/contribute/style/hugo-shortcodes/index.md

 * Learn about [using page templates](/docs/home/contribute/page-templates/).
 * Learn about [staging your changes](/docs/home/contribute/stage-documentation-changes/)
 * Learn about [creating a pull request](/docs/home/contribute/create-pull-request/).
-{{% /capture %}}


Sorry about this one :(

This file/change is not needed (this file set to the original version)?

celestehorgan · 2020-03-10T15:50:17Z

Commit #d0c0a56 addresses feedback from @kbhawkey. There were a few things to look at here:

The wholesale removal of lots of the "work from a local fork" info, which Karen found useful
Some weird formatting issues around the tabs, which swallowed and ate some of the subsections below it in the original preview
General organization, grammar, etc.

Given the change, I think the logical reviewers are @kbhawkey @zacharysarah.

content/en/docs/contribute/new-content/contributing-content.md

content/en/docs/contribute/_index.md

content/en/docs/contribute/new-content/contributing-content.md

kbhawkey · 2020-03-10T16:07:39Z

@celestehorgan , I'll try and read the updates to fork+clone+pr.
Also, does the first commit belong on this branch?

celestehorgan · 2020-03-10T17:06:06Z

@kbhawkey It does. It changes the URL on an old, deleted page, but I did make sure to update the same link in its new location.

zacharysarah

@celestehorgan Here's a start. I can't review any further without throwing a pink unicorn. 🦄

content/en/docs/contribute/_index.md

content/en/docs/contribute/review/for-approvers.md

zacharysarah · 2020-03-11T22:43:11Z

@celestehorgan Because this PR is so large, I've almost certainly missed things. Also, too many suggestions lead to pink unicorns. Hopefully what I've added can point you to other things that need fixing. Please let me know if you have any questions!

content/en/docs/contribute/_index.md

content/en/docs/contribute/new-content/_index.md

content/en/docs/contribute/new-content/new-features.md

celestehorgan · 2020-04-02T23:05:43Z

static/_redirects

-
 /docs/contribute/write-new-topic/        /docs/home/contribute/write-new-topic/ 301
+/docs/contribute/start/        /docs/contribute/ 301
+/docs/contribute/intermediate/        /docs/contribute/ 301


@kbhawkey I added two redirects here, but the implication of this reorganization is that there's no directly equivalent section to redirect to. I'm not sure these are useful?

kbhawkey · 2020-04-03T01:46:56Z

/remove-area blog

kbhawkey · 2020-04-03T01:48:42Z

/remove-language zh
/remove-language ru

kbhawkey · 2020-04-03T01:49:38Z

/remove-language de
/remove-language id
/remove-language pl

Signed-off-by: Celeste Horgan <celeste@cncf.io>

celestehorgan · 2020-04-07T19:35:50Z

cc: @zacharysarah

zacharysarah · 2020-04-07T23:12:15Z

@celestehorgan Thanks for reorganizing this content and making it more friendly! ✨

This PR looks good to me, and I'm approving it.

Some feedback for a follow-up PR:

Make "Documenting for a Release" the first left nav option
Retitle "Suggesting content improvements" to "Improving content" and swap places with "Documenting for a release"

/lgtm
/approve

k8s-ci-robot · 2020-04-07T23:12:39Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: zacharysarah

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

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [zacharysarah]

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 added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Mar 9, 2020

k8s-ci-robot requested review from Rajakavitha1 and steveperry-53 March 9, 2020 19:47

k8s-ci-robot added language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Mar 9, 2020

k8s-ci-robot changed the title ~~Restructure and consolidate information in Contribute section~~ [WIP] Restructure and consolidate information in Contribute section Mar 10, 2020

k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 10, 2020

celestehorgan force-pushed the temporary-branch-2 branch from cbf199b to d875110 Compare March 10, 2020 09:34

celestehorgan changed the title ~~[WIP] Restructure and consolidate information in Contribute section~~ Restructure and consolidate information in Contribute section Mar 10, 2020

k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 10, 2020

celestehorgan commented Mar 10, 2020

View reviewed changes

kbhawkey reviewed Mar 10, 2020

View reviewed changes

content/en/docs/contribute/new-content/contributing-content.md Outdated Show resolved Hide resolved

kbhawkey reviewed Mar 10, 2020

View reviewed changes

content/en/docs/contribute/new-content/contributing-content.md Outdated Show resolved Hide resolved

kbhawkey reviewed Mar 10, 2020

View reviewed changes

content/en/docs/contribute/_index.md Outdated Show resolved Hide resolved

kbhawkey reviewed Mar 10, 2020

View reviewed changes

content/en/docs/contribute/new-content/contributing-content.md Outdated Show resolved Hide resolved

zacharysarah suggested changes Mar 11, 2020

View reviewed changes

kbhawkey reviewed Mar 12, 2020

View reviewed changes

content/en/docs/contribute/_index.md Outdated Show resolved Hide resolved

kbhawkey reviewed Mar 12, 2020

View reviewed changes

content/en/docs/contribute/_index.md Outdated Show resolved Hide resolved

kbhawkey reviewed Mar 12, 2020

View reviewed changes

content/en/docs/contribute/new-content/_index.md Outdated Show resolved Hide resolved

kbhawkey reviewed Mar 12, 2020

View reviewed changes

content/en/docs/contribute/new-content/new-features.md Show resolved Hide resolved

k8s-ci-robot added language/id Issues or PRs related to Indonesian language language/pl Issues or PRs related to Polish language language/ru Issues or PRs related to Russian language language/zh Issues or PRs related to Chinese language labels Apr 2, 2020

celestehorgan force-pushed the temporary-branch-2 branch from 1830580 to f71c277 Compare April 2, 2020 19:39

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Apr 2, 2020

celestehorgan commented Apr 2, 2020

View reviewed changes

k8s-ci-robot removed the area/blog Issues or PRs related to the Kubernetes Blog subproject label Apr 3, 2020

k8s-ci-robot removed language/zh Issues or PRs related to Chinese language language/ru Issues or PRs related to Russian language labels Apr 3, 2020

k8s-ci-robot removed language/de Issues or PRs related to German language language/id Issues or PRs related to Indonesian language language/pl Issues or PRs related to Polish language labels Apr 3, 2020

celestehorgan force-pushed the temporary-branch-2 branch from 5a6dd1f to eb866df Compare April 7, 2020 19:20

Restructure to reduce duplication

f0cded0

Signed-off-by: Celeste Horgan <celeste@cncf.io>

celestehorgan force-pushed the temporary-branch-2 branch from eb866df to f0cded0 Compare April 7, 2020 19:26

k8s-ci-robot assigned zacharysarah Apr 7, 2020

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 7, 2020

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 7, 2020

k8s-ci-robot merged commit 2b99761 into kubernetes:master Apr 7, 2020

zacharysarah mentioned this pull request Apr 10, 2020

Umbrella Issue: Clean up duplicate content in Contribute section #18878

Closed

sftim mentioned this pull request Apr 18, 2020

“Contributing new content overview” specifies Developer Certificate of Origin, which is not actually enforced #20426

Closed

Sea-n mentioned this pull request Jun 18, 2022

Tweak localization page #34374

Merged

s-kawamura-w664 mentioned this pull request Mar 10, 2023

[ja] Update page weights under content/ja/docs/contribute #39901

Merged

Conversation

celestehorgan commented Mar 9, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

celestehorgan commented Mar 9, 2020

Uh oh!

netlify bot commented Mar 9, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

celestehorgan commented Mar 9, 2020

Uh oh!

sftim commented Mar 10, 2020

Uh oh!

celestehorgan commented Mar 10, 2020

Uh oh!

celestehorgan Mar 10, 2020

Choose a reason for hiding this comment

Uh oh!

kbhawkey Mar 24, 2020

Choose a reason for hiding this comment

Uh oh!

celestehorgan commented Mar 10, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kbhawkey commented Mar 10, 2020

Uh oh!

celestehorgan commented Mar 10, 2020

Uh oh!

zacharysarah left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

zacharysarah commented Mar 11, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

celestehorgan Apr 2, 2020

Choose a reason for hiding this comment

Uh oh!

kbhawkey Apr 3, 2020

Choose a reason for hiding this comment

Uh oh!

kbhawkey commented Apr 3, 2020

Uh oh!

kbhawkey commented Apr 3, 2020

Uh oh!

kbhawkey commented Apr 3, 2020

Uh oh!

celestehorgan commented Apr 7, 2020

Uh oh!

zacharysarah commented Apr 7, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

k8s-ci-robot commented Apr 7, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

celestehorgan commented Mar 9, 2020 •

edited

Loading

netlify bot commented Mar 9, 2020 •

edited

Loading

zacharysarah commented Apr 7, 2020 •

edited

Loading