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 invalid links in documentation. #7008

Merged
merged 1 commit into from Sep 28, 2023
Merged

Fix invalid links in documentation. #7008

merged 1 commit into from Sep 28, 2023

Conversation

simi
Copy link
Member

@simi simi commented Sep 28, 2023

  • wrap ENV variables in <code>
  • fix rubygems.org link
  • fix zenspider.com link

fixes #6986

- wrap ENV variables in <code>
- fix rubygems.org link
- fix zenspider.com link
@simi simi marked this pull request as ready for review September 28, 2023 00:30
Copy link
Member

@deivid-rodriguez deivid-rodriguez left a comment

Choose a reason for hiding this comment

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

😍

@deivid-rodriguez deivid-rodriguez merged commit c0ad937 into master Sep 28, 2023
83 checks passed
@deivid-rodriguez deivid-rodriguez deleted the fix-links branch September 28, 2023 06:49
@nobu
Copy link
Contributor

nobu commented Oct 3, 2023

Please separate the subject line in the commit log from the rest by an empty line, as the git's convention.

@simi
Copy link
Member Author

simi commented Oct 3, 2023

Please separate the subject line in the commit log from the rest by an empty line, as the git's convention.

Is it? I have never seen that anywhere being convention. Any reference on that? I'll do next time. Sorry for troubles.

@deivid-rodriguez
Copy link
Member

We could configure https://github.com/bkuhlmann/git-lint#github-actions if we wanted to enforce this. Particularly if it could cause some ruby-core scripts to break.

@nobu
Copy link
Contributor

nobu commented Oct 3, 2023

git treats the first paragraph (separated by an empty line) of commit logs as subjects, and concatenates all lines in the paragraph with a space.

I can't share the good pointer, but you can see the subject of the commit is one line:

$ git --no-pager log --pretty=%s -1 9eaac94a63
Fix invalid links in documentation. - wrap ENV variables in <code> - fix rubygems.org link - fix zenspider.com link

In this case, %b (body) is empty.

deivid-rodriguez added a commit that referenced this pull request Oct 13, 2023
Fix invalid links in documentation.

(cherry picked from commit c0ad937)
deivid-rodriguez added a commit that referenced this pull request Oct 13, 2023
Fix invalid links in documentation.

(cherry picked from commit c0ad937)
deivid-rodriguez added a commit that referenced this pull request Oct 13, 2023
Fix invalid links in documentation.

(cherry picked from commit c0ad937)
deivid-rodriguez added a commit that referenced this pull request Oct 16, 2023
Fix invalid links in documentation.

(cherry picked from commit c0ad937)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Broken links in documentation
3 participants