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

Fix book repository URLs #1877

Merged
merged 4 commits into from
Sep 26, 2024
Merged

Conversation

dscho
Copy link
Member

@dscho dscho commented Sep 26, 2024

Changes

This is a fix for a regression I introduced in #1804, which I happened to notice while working on something completely different.

Context

On the sidebar of the ProGit book and its translations, there is a link to the repository, to direct eager contributors to the place where they can contribute their changes.

However, I only seem to have tested this with the front pages of the various translations, as the link is bogus on every other page of the book.

An example can be seen e.g. here: https://git-scm.com/book/en/v2/Getting-Started-About-Version-Control. The link "The source of this book is hosted on GitHub." points to itself.

This PR fixes that. Demo: https://dscho.github.io/git-scm.com/book/en/v2/Getting-Started-About-Version-Control (where I branch-deployed this fix).

We try to indent only with spaces over here.

Signed-off-by: Johannes Schindelin <[email protected]>
The URL is already stored in the front matter of the front page of each
translation. However, we need it on every page, not just the front page,
because the repository link is shown on the bottom of the sidebar.

Signed-off-by: Johannes Schindelin <[email protected]>
This trick was performed by letting the freshly-modified
`script/book.rb` script do its job.

Signed-off-by: Johannes Schindelin <[email protected]>
@dscho dscho self-assigned this Sep 26, 2024
The repository link worked for the front page of each translation of the
book, but not for any other page.

Now that the URL is stored in the site-wide data, we can fix this.

Signed-off-by: Johannes Schindelin <[email protected]>
@dscho dscho force-pushed the fix-book-repository-URLs branch from 139c63c to 041f29f Compare September 26, 2024 12:36
@ttaylorr ttaylorr merged commit 55ec5d0 into git:gh-pages Sep 26, 2024
1 check passed
@dscho dscho deleted the fix-book-repository-URLs branch September 26, 2024 15:20
@dscho
Copy link
Member Author

dscho commented Sep 26, 2024

From https://github.com/git/git-scm.com/actions/runs/11055205763/job/30713847974:

2024-09-26T15:19:14.7924112Z ##[error]Creating Pages deployment failed
2024-09-26T15:19:14.7931542Z ##[error]HttpError: Deployment request failed for 55ec5d0 due to in progress deployment. Please cancel 09a0069 first or wait for it to complete.

I did not anticipate PRs to be merged in such rapid succession ;-) Guess we need some concurrency, after all. I triggered a deployment manually.

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