*: Assorted internal-reference cleanups #2174
Conversation
k8s-ci-robot
added
size/M
k8s-ci-robot
added
needs-ok-to-test
wking
force-pushed
the
internal-link-fixups
branch
2 times, most recently
from
8d5390e
to
7d86321
Compare
|
Please have a look at https://github.com/kubernetes/community/blob/master/sig-contributor-experience/markdown-link-style-guide.md. There are a lot of positional references (e.g. |
wking
force-pushed
the
internal-link-fixups
branch
from
7d86321
to
e008e0d
Compare
Thanks for the policy link. It's probably worth dropping a reference to it in the root |
k8s-ci-robot
added
the
needs-rebase
wking
force-pushed
the
internal-link-fixups
branch
from
e008e0d
to
13aae20
Compare
k8s-ci-robot
added
sig/node
|
Rebased onto master with e008e0d -> 13aae20. Git reported no conflicts, but comparing the diffs I think GitHub's issue was the rename in #2246. Is there anything I can do to help this PR along so I can avoid future rebasing? I'm happy to break it down into a bunch of per-file PRs or whatever if that would help with review. |
|
/ok-to-test |
k8s-ci-robot
removed
the
needs-ok-to-test
|
As you've modified a template, one of the docs needs to be regenerated. |
wking
force-pushed
the
internal-link-fixups
branch
from
13aae20
to
ca74dc3
Compare
generator/list.tmpl
Outdated
|
|
||
| SIGs follow these [guidelines](governance.md) although each of these groups may operate a little differently | ||
| depending on their needs and workflow. | ||
|
|
||
| Each group's material is in its subdirectory in this project. | ||
|
|
||
| When the need arises, a [new SIG can be created](sig-creation-procedure.md) | ||
| When the need arises, a [new SIG can be created](sig-governance.md#sig-creation-and-maintenance-procedure.md). |
wking
force-pushed
the
internal-link-fixups
branch
from
ca74dc3
to
4833c3c
Compare
k8s-ci-robot
added
the
needs-rebase
This is mostly replacing https://github.com/kubernetes/community/blob/master/... links with relative links, because relative links are easier to maintain. For example, if you rename a.md to b.md in a feature branch, updating an /a.md to /b.md target will work immediately (e.g. during pull-request review), while updating https://github.com/kubernetes/community/blob/master/a.md to https://github.com/kubernetes/community/blob/master/b.md will only work after your branch lands the rename in master. I'm not sure why the #L1454 fragment was part of the old sig-governance template sigs.yaml link, but it's been there since the template landed in 68658bf (Provide short template for SIG governance, 2018-02-23, kubernetes#1830). I've removed it in this commit. The Kubernetes Charter README link in the sig-governance template could just be: [Kubernetes Charter README]: README.md but I've based it on the project root and back to make life easier on new SIGs which copy/paste the file to a new location in this repository. I personally prefer targets that use ../ for referencing other directories within a project, because those also work with generic Markdown tools (e.g. Emacs' Markdown mode). I've gone with /-rooted targets in this commit as requested in /sig-contributor-experience/markdown-link-style-guide.md. I've also chased a few files and anchors as they've moved around, e.g. the OBSOLETE_templates.md rename from 18958f8 (addressing Brians comments, 2017-09-06, kubernetes#1010) and the "and maintenance" header addition from f471f6b (Add new contact info for Paris and me, 2017-10-17, This commit isn't complete, but it's a step in the right direction and all I had time for tonight ;). The sig-list.md changes were generated automatically from the generator/list.tmpl changes with: $ make generate
wking
force-pushed
the
internal-link-fixups
branch
from
4833c3c
to
8e15a8d
Compare
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: Assign the PR to them by writing The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
removed
the
needs-rebase
Rebased onto master with 4833c3c -> 8e15a8d. GitHub had complained about a |
|
@wking: PR needs rebase. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
k8s-ci-robot
added
the
needs-rebase
|
Issues go stale after 90d of inactivity. If this issue is safe to close now please do so with Send feedback to sig-testing, kubernetes/test-infra and/or fejta. |
k8s-ci-robot
added
the
lifecycle/stale
|
Stale issues rot after 30d of inactivity. If this issue is safe to close now please do so with Send feedback to sig-testing, kubernetes/test-infra and/or fejta. |
k8s-ci-robot
added
lifecycle/rotten
|
Rotten issues close after 30d of inactivity. Send feedback to sig-testing, kubernetes/test-infra and/or fejta. |
|
@fejta-bot: Closed this PR. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
This is mostly replacing
https://github.com/kubernetes/community/blob/master/...links with relative links, because relative links are easier to maintain. For example, if you renamea.mdtob.mdin a feature branch, updating an../a.mdto../b.mdtarget will work immediately (e.g. during pull-request review), while updatinghttps://github.com/kubernetes/community/blob/master/a.mdtohttps://github.com/kubernetes/community/blob/master/b.mdwill only work after your branch lands the rename in master.I'm not sure why the
#L1454fragment was part of the old sig-governance template sigs.yaml link, but it's been there since the template landed in 68658bf (#1830). I've removed it in this commit.The Kubernetes Charter README link in the sig-governance template could just be:
but I've sent it down to the project root and back to make life easier on new SIGs which copy/paste the file to a new location in this repository. With this pull request they'll just need to drop one level of
../to get the references working from places likesig-contributor-experience/charter.md.I've also chased a few files and anchors as they've moved around, e.g. the
OBSOLETE_templates.mdrename from 18958f8 (#1010) and the "and maintenance" header addition from f471f6b (#1215).This pull request isn't complete, but it's a step in the right direction and all I had time for tonight ;).