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.

Sign up for GitHub

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

Jump to bottom

Build docs from .adoc sources #1973

Merged
merged 1 commit into from
Mar 12, 2025
Merged

Build docs from .adoc sources #1973

merged 1 commit into from
Mar 12, 2025

Conversation

To1ne
Copy link
Contributor

@To1ne To1ne commented Mar 12, 2025

Changes

Fix #1944 and allow building from .adoc sources.

Context

Recently .txt documentation was renamed to .adoc in the upstream repo https://github.com/git/git.

@To1ne To1ne changed the title Toon adoc Build docs from .adoc sources Mar 12, 2025
@To1ne
Copy link
Contributor Author

To1ne commented Mar 12, 2025

It's a bit dirty, but it seems to work.

@To1ne
Copy link
Contributor Author

To1ne commented Mar 12, 2025

Preview at https://to1ne.github.io/git-scm.com/docs/git-clone.

@dscho Can you please review? I'll remove the second and third commit if you like.

@dscho
Copy link
Member

dscho commented Mar 12, 2025

Preview at https://to1ne.github.io/git-scm.com/docs/git-clone.

@dscho Can you please review? I'll remove the second and third commit if you like.

I'm on it.

dscho
dscho reviewed Mar 12, 2025
View reviewed changes
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.

I like the changes, thank you! And the third commit nicely proves the correctness of the changes. And yes, now that the third commit did an excellent job of that, I'd like to drop it before merging.

@To1ne
script/update-docs: add support for .adoc files
a74b38c 
Since 2.49.0 the documentation files are named with the .adoc extension.
Adapt the script to support that.

Signed-off-by: Toon Claes <[email protected]>
@To1ne
Copy link
Contributor Author

To1ne commented Mar 12, 2025 •
edited
Loading

@dscho Rebased, removed the extra commits and addressed your feedback.

@dscho
Copy link
Member

dscho commented Mar 12, 2025

@dscho Rebased, removed the extra commits and addressed your feedback.

Thank you for indulging me! I especially like this new comment:

+          # use txt_path for backward compatibility of already-existing
+          # deep links shared across the interwebs.

@dscho dscho merged commit c00b6e9 into git:gh-pages Mar 12, 2025
1 check passed
This was referenced Mar 12, 2025
Closed
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dscho dscho dscho left review comments

@jnavila jnavila jnavila left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Prepare for upcoming *.txt -> *.adoc bulk rename
3 participants
@To1ne @dscho @jnavila