Repository navigation
[Doc]: Dead link in dev workflow docs #29305
Description
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)
Activity
QuLogic commentedon 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 commentedon Dec 16, 2024
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 commentedon Dec 16, 2024
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."
Khushikela29 commentedon Jan 11, 2025
I came across this issue and would love to contribute to it. Could you please let me know if it's available for me to work on?
timhoffm commentedon Jan 11, 2025
Yes, you are welcome to create a pull request. I suggest to change as proposed by @story645 above (#29305 (comment)).
Khushikela29 commentedon Jan 12, 2025
I've opened a Pull request, you can check & let me know if any other changes required.