Skip to content

Update redirected links in contributing.md to canonical URLs - #687

Open
lisancao wants to merge 3 commits into
apache:asf-sitefrom
lisancao:update-contributing-redirected-links
Open

lisancao wants to merge 3 commits into
apache:asf-sitefrom
lisancao:update-contributing-redirected-links

Conversation

@lisancao

Copy link
Copy Markdown
Contributor

Five external links in contributing.md (and the rendered site/contributing.html) currently return 200 only via redirect to canonical destinations:

Link New canonical URL
https://help.github.com/articles/fork-a-repo/ https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo
https://help.github.com/articles/using-pull-requests/ https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests
http://legacy.python.org/dev/peps/pep-0008/ https://peps.python.org/pep-0008/
http://www.oracle.com/technetwork/java/codeconvtoc-136057.html https://www.oracle.com/java/technologies/javase/codeconventions-contents.html
http://docs.scala-lang.org/style/ https://docs.scala-lang.org/style/

GitHub deprecated help.github.com in favor of docs.github.com, Oracle deprecated technetwork, and the two HTTP URLs upgrade to HTTPS. The redirects work today but the canonical URLs are stable forever.

The change touches both contributing.md and site/contributing.html to keep the source and rendered files in sync, matching the convention from PR #679 (Fix a couple of typos in contributing.md).

Generated-by: Claude Opus 4.7 (1M context) (claude-opus-4-7)

Five external links in contributing.md (and the rendered site/contributing.html)
currently return 200 only via redirect:

  - help.github.com (deprecated) to docs.github.com (2 occurrences)
  - oracle.com/technetwork (deprecated) to oracle.com/java/technologies (1)
  - http://legacy.python.org/dev/peps to https://peps.python.org (1)
  - http://docs.scala-lang.org to https://docs.scala-lang.org (1)

Each is updated to its current canonical URL.

Generated-by: Claude Opus 4.7 (1M context) (claude-opus-4-7)

@nchammas nchammas 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 updating these links. Could you check them again? It appears a couple of them still redirect to someplace else (perhaps due to the time that has passed since you initially submitted this PR).

Also, you don't need to submit changes to site/ anymore thanks to #699.

GitHub reorganized its docs again since this PR was opened, so the
fork-a-repo and about-pull-requests URLs set here now 301-redirect.
Point them at the current canonical paths.
Site HTML is generated and pushed automatically now (apache#699),
so this PR should change contributing.md only.
@lisancao

Copy link
Copy Markdown
Contributor Author

Thanks @nchammas. Refreshed both GitHub links to the current canonical paths:

  • fork-a-repo → https://docs.github.com/en/pull-requests/how-tos/work-with-forks/fork-a-repo
  • about-pull-requests → https://docs.github.com/en/pull-requests/reference/pull-requests

Verified both return 200 with no redirect. The other three (peps.python.org, oracle, docs.scala-lang.org) still resolve cleanly, so I left them. Also dropped the site/contributing.html change, so this is contributing.md only now, per #699.

@nchammas nchammas 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.

LGTM pending a refresh of the PR description to reflect the current diff. I would also remove the actual before/after URLs from the description since they are already captured in the diff.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants