Skip to content

fix broken links: change from .txt to .adoc #2008

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

Merged
merged 2 commits into from
Jul 2, 2025
Merged

Conversation

Botato300
Copy link
Contributor

Changes

  • Just change from .txt to .adoc

Context

Some links like “/docs/howto/update-hook-example” redirected to URLs ending in .txt, which no longer exist. They now redirect to the same URLs ending in .adoc.
Issue associated: #2006

Copy link
Member

@dscho dscho left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks correct!

I will need to re-run the GitHub workflow to re-generate the manual pages with this change. However, the result would conflict with #2007 at the moment, therefore I will hold off until that PR is merged, then go ahead and integrate this here PR so that the results will not conflict.

@dscho dscho linked an issue May 21, 2025 that may be closed by this pull request
@dscho
Copy link
Member

dscho commented May 26, 2025

I will need to re-run the GitHub workflow to re-generate the manual pages with this change.

For the record, I did that a couple of days ago, but despite my local confirmation that the patch works, the workflow did not result in any changes :-(

@To1ne
Copy link
Collaborator

To1ne commented Jun 3, 2025

change from .txt to .adoc

This gift keeps on giving. I'll try to have a look tomorrow.

Botato300 and others added 2 commits July 2, 2025 18:25
Some links like “/docs/howto/update-hook-example” redirected to URLs ending in .txt, which no longer exist. They now redirect to the same URLs ending in .adoc.
The script determines that it does not need to do anything if the
`docs/howto/*.html` in question exists already. But we have to fix the
`.txt` extension, which is now the `.adoc` extension.

So, after `git rm external/docs/content/docs/howto/*.html`, I simply
re-built them via:

	REBUILD_DOC=v2.50.0 RERUN=1 \
	bundle exec ruby script/update-docs.rb git-worktree en

Signed-off-by: Johannes Schindelin <[email protected]>
@dscho
Copy link
Member

dscho commented Jul 2, 2025

I will need to re-run the GitHub workflow to re-generate the manual pages with this change.

For the record, I did that a couple of days ago, but despite my local confirmation that the patch works, the workflow did not result in any changes :-(

I figured it out. The problem is this line:

if !File.exist?(doc_path)

That's the line responsible for not re-generating the /docs/howto/* files: It first verifies the absence of the static file. But that file already exists, so the script thinks there is nothing to do anymore.

@dscho dscho merged commit d6f49c9 into git:gh-pages Jul 2, 2025
1 check passed
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.

broken links like “/docs/howto/update-hook-example”
3 participants