Project

General

Profile

Actions

Bug #16875

closed

hard linebreaks in developer docs on katello.org

Added by Evgeni Golov over 7 years ago. Updated almost 6 years ago.

Status:
Closed
Priority:
Normal
Assignee:
-
Category:
Documentation
Target version:
Difficulty:
Triaged:
Fixed in Releases:
Found in Releases:

Description

see e.g. http://www.katello.org/developers/style/git_commit_messages.html

the html contains many br tags in places where there should be none:

<p>Git commit messages should give a brief overview of the problem or feature along with a short<br />
description of what was implemented to fix the bug or feature. Well formatted git commit messages<br />
have two components: a short message and a long message or description.  The short message ought to<br />
be limited to 70 characters while the long message should be wrapped at 74 or so characters.  See<br />
below for an example. Also, you can read <a href="http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html">Tim Pope’s article about git message<br />
formatting</a>.</p>

it seems that the markdown converter converts "\n" to "<br>", while markdown actually demands only " space space \n" to be translated like this.

Actions #1

Updated by Justin Sherrill over 7 years ago

  • translation missing: en.field_release set to 114
Actions #2

Updated by Evgeni Golov over 7 years ago

So the issue seems to be http://kramdown.gettalong.org/options.html#option-hard-wrap
But adding hard_wrap: false to the kramdown section of _config.yml does not seem to help.

Actions #3

Updated by Evgeni Golov over 7 years ago

Partial progress, it works OK when I use markdown: kramdown, but not with markdown: KramdownPygments as we use it.

Actions #4

Updated by The Foreman Bot over 7 years ago

  • Status changed from New to Ready For Testing
  • translation missing: en.field_release deleted (114)
  • Pull request https://github.com/Katello/katello.org/pull/329 added
Actions #5

Updated by Evgeni Golov over 7 years ago

  • Status changed from Ready For Testing to Closed
  • % Done changed from 0 to 100
Actions #6

Updated by Eric Helms over 7 years ago

  • translation missing: en.field_release set to 188
Actions

Also available in: Atom PDF