Migrate existing Prow docs over to this repo about prow HOT 10 CLOSED

I've done another refresh of the Legacy Snapshot in #22. After that is merged, we can merge kubernetes/test-infra#27818 to let folks know that the old doc locations in k/t-i are deprecated.

The final step is to update/reorganize/rearrange the contents from the Legacy Snapshot. However we can also just add new content on the side, and later mark things in the Legacy Snapshot as being "dated". The one benefit of the Legacy Snapshot is that at least we get a table-of-contents of every single Prow markdown file, which was previously only discoverable via grepping through the sources (or through enough determined mouse clicks). So in this sense it's something that can happen over a longer period of time. Most likely things will happen organically here.

from prow.

Hello, I am Jihoon Seo, one of the K8s SIG Docs Korean l10n approvers.

I was organizing my mailbox and noticed the K8s dev group email about "Prow Documentation Revamp", and that mail led me to here.

Here I try suggesting the placement of some Legacy Snapshot documents to the current Prow docs site pages.

[Prow docs site TOC]

• Announcements (This page seems already having contents.)
• Overview ← https://github.com/kubernetes-sigs/prow/blob/main/site/content/en/docs/Legacy%20Snapshot/prow/README.md
  • Architecture (This page seems already having contents.)
• Components ← https://github.com/kubernetes-sigs/prow/blob/main/site/content/en/docs/Legacy%20Snapshot/prow/cmd/README.md
  • Deck (This page seems already having contents.)
  • Sub (This page seems already having contents.)
• GKE Build Clusters (This page seems already having contents.)
• Contribution Guidelines (This page seems already having contents.)
• Metrics (This page seems already having contents.)

Apart from the migrating job of some pages, the first thing I want to do is to update the links in the Legacy Snapshot documents (e.g., https://docs.prow.k8s.io/docs/legacy-snapshot/prow/cmd/readme/).
For now those links are pointing to the pages under https://github.com/kubernetes/test-infra/tree/master/prow/ , where users will just see the DOCUMENTATION DEPRECATION NOTICE.
Updating these ineffective links to point the pages under the Legacy Snapshot documents in the new Prow docs site might give some convenience to the users by enabling to browse over existing documents, although those are 'legacies'.

from prow.

Hello @jihoon-seo, those suggestions sound fine. Ultimately (next quarter? 6 months from now?) the files under the Legacy Snapshot should point to new (replacement) content. I am currently busy prioritizing other things but I hope to get back to this issue by the end of the year.

from prow.

/assign @listx

from prow.

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue or PR as fresh with /remove-lifecycle stale
• Mark this issue or PR as rotten with /lifecycle rotten
• Close this issue or PR with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

from prow.

/remove-lifecycle stale

from prow.

@listx I revisited #4 (comment) again, and noticed that I missed your phrase:

We need to identify content that needs to be migrated over, create a migration task list for each of those content areas, and then one-by-one do the actual migration.

Sorry for opening a huge PR (#26) before creating & suggesting a migration task list.
It would be okay for you (and anyone) to do either:

• give review comments in #26, then I will update the PR, and we can discuss with the updated Netlify preview
• or, we first close #26, create a migration task list, and then one-by-one do the actual migration.

I made a Google spreadsheet that represents the TOC of my suggestion.
You can also check a Netlify preview of the PR #26.
Please leave any comments, and we would be able to move forward.

from prow.

Sorry for opening a huge PR (#26) before creating & suggesting a migration task list.

Not at all! I'm happy with trying to get #26 merged first, and then iterating (if necessary) after that. I left a few suggestions in that PR, so we can follow up there.

Thank you for taking on this work!

from prow.

I think with all the work that @jihoon-seo has done, we can close this issue. We can tackle additional necessary revisions in the umbrella issue in #31.

/close

from prow.

@listx: Closing this issue.

from prow.