Prepare for upcoming *.txt -> *.adoc bulk rename #1944
Comments
|
Just like to point out that the link to the latest release notes (Shown in monitor image on the front page and download page) is now broken because of this. It points to https://raw.githubusercontent.com/git/git/master/Documentation/RelNotes/2.48.1.txt while it should point to https://raw.githubusercontent.com/git/git/master/Documentation/RelNotes/2.48.1.adoc |
That's sad. Do you have time to work on this? I currently lack the time. |
@erikdendekker you can thank @aeiouaeiouaeiouaeiouaeiouaeiou over in #1954 for fixing this. |
@dscho It seems the patch series landed. And 2.49 is around the corner. How hard is the script breaking now? Shall we pick this up? |
Yep.
Yep.
$ git rm -r external/docs/ &&
mkdir -p external/docs/content/docs &&
REBUILD_DOC=v2.49.0-rc1 ruby script/update-docs.rb /path/to/git-checkout en &&
find external/docs/ -type f | wc
2 2 67
For comparison: And for the record, these lines indicate a regression thanks to the Meson changes:
@To1ne If you have the time and the motivation; I do not. |
|
I just noticed we have to make sure not to break permalinks like |
Well spotted, I missed that! This |
|
Hah, there are more issues. Derp. https://lore.kernel.org/git/CAEiLEbOZ7vGE6U69sf5nK+G86zaeAMRTrjaCr=rF2JU1H1p8ww@mail.gmail.com/ Hi Git Community, The link to the release notes for v2.48.1 on the git-scm downloads It links to: https://raw.githubusercontent.com/git/git/master/Documentation/RelNotes/2.48.1.txt It looks like the master branch now uses '.adoc' extension since this Using either of these URLs loads the release notes correctly:
|
|
@To1ne don't you love the impulsive response "This ain't our problem". As if the millions of links out there to Git's release notes that were in such a consistent format for over a decade so that people had come to rely on it, sometimes in commits (that are immutable) weren't Git's responsibility. I'm speechless. |
|
As for https://git-scm.com/downloads, this seems to have been adjusted in #1954, though. |
|
Well, Hyrum's law doesn't really apply here, because they went directly to breaking the interface. As Junio himself says, the RelNotes were never meant to be asciidoc. |
Oh, but Hyrum's law totally applies here, because it's not up to maintainers to decide what users expect, and just wishing away users' expectations is a strategy that's always going to fail, every single time. Junio can say that The fact that they went directly to breaking the interface very much implies that they violated Hyrum's law, big time, whether willfully or obliviously is unclear. I wonder whether there would have been smarter decisions that could have been made. |
|
Is this change compatible with the processing of translations where I would also rename files |
@jnavila #1973 does nothing to the |
|
@jnavila I adapted the script in #1976 so that it will also handle What took me the longest time was to make the |
@dscho Sorry for missing that. I somehow knew I should fix those too, but then I forgot. But to be honest, I don't fully understand why those codepaths are so different?
I seem to have been completely unaware of the workflow to follow to generate localized docs. I didn't realize how much more complex the workflow is to get localized docs. I hope we've covered all now for the upcoming 2.49 release. |
|
@To1ne to be fully transparent, I had looked at the repository name, Only when I looked more closely after @jnavila raised his concerns did I spot that AsciiDoctor is still used in that code path. What took the longest time was to create the local commit in the I hope that this is all that's needed in git-scm.com to react to that bulk rename. However, my intuition tells me that this kind of disruptive change is a gift that will keep on giving. We'll have to see. Based on what I observed, there is no help to be expected from those who caused the disruption. |
@dscho The only help I'm expecting is them saying "hey X is broken" when they discover something isn't working. And if we make everything work flawlessly, we'll hear nothing. |
Well, we all say that X is broken. Twitter was much better, and certainly not seriously under-staffed.
Yep. Story of my life. |
You're right: #1978 |
There is a proposed patch series to rename the
*.txtfiles inDocumentation/to*.adoc.Where
*.txtfiles are available, people frequently run various commands to parse and consume them, including tooling for static websites as this one. Which means that such a rename breaks that tooling.I agree that this would have been a nice feature to add at the beginning of the development of the documentation, but I fear that it is too late to make an incompatible change now. However, as opposed to increasing Git's safety stance, the convenience of a few who want to have syntax highlighting in editors based on the file extension apparently is important enough to merit just such an incompatible change.
This means that
script/update-docs.rbwill need to be adapted once the tooling here breaks. Or before it. If someone volunteers.The text was updated successfully, but these errors were encountered: