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

[Doc]: Dead link in dev workflow docs #29305

Open
ksunden opened this issue Dec 14, 2024 · 3 comments
Open

[Doc]: Dead link in dev workflow docs #29305

ksunden opened this issue Dec 14, 2024 · 3 comments

Comments

@ksunden
Copy link
Member

ksunden commented Dec 14, 2024

Documentation Link

No response

Problem

In running link checker for the 3.10 release, I found a dead link with the original resource appearing to no longer exist:

doc/devel/development_workflow.rst
146:.. _why the -a flag?: http://gitready.com/beginner/2009/01/18/the-staging-area.html

Suggested improvement

There are probably a number of reasonable alternatives, my leaning though I have not evaluated other alternatives would probably be to replace it with the git official website link about the staging area

https://git-scm.com/about/staging-area

It is not that overwhelmingly detailed, but does have a "if you don't want the full control just use -a" which is the main point of the link I think.

Not sure if there are more beginner focused resources that we may prefer (The previous link did have 'beginner' in the URL, but I do not know what the contents of the page were)

@QuLogic
Copy link
Member

QuLogic commented Dec 14, 2024

Here's a random snapshot: https://web.archive.org/web/20100106071734/https://gitready.com/beginner/2009/01/18/the-staging-area.html

It's not a very long page, not too much longer than the page you suggested. It also linked to the Git book, but that seems to have had a v2 refresh and the page no longer exists. Maybe https://git-scm.com/book/en/v2/Git-Basics-Recording-Changes-to-the-Repository is the closest to that.

@tacaswell
Copy link
Member

Or just remove the whole comment. Some of this content dates from when we were on the front edge of the SVN -> git transition, where as now git is by far the dominate VC tool. Knowing how to use git is not never a barrier to contributing, but it is a much (much) rarer one than it used to be.

@story645
Copy link
Member

Um. I think easiest is "For more information, see why the -a flag? and the git commit manual page."->"For more information, see the git commit manual page."

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

No branches or pull requests

4 participants