[
https://issues.apache.org/jira/browse/CAMEL-12708?focusedWorklogId=186334&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-186334
]
ASF GitHub Bot logged work on CAMEL-12708:
------------------------------------------
Author: ASF GitHub Bot
Created on: 17/Jan/19 14:57
Start Date: 17/Jan/19 14:57
Worklog Time Spent: 10m
Work Description: DenisIstomin commented on pull request #2714:
CAMEL-12708: Fix atx-style section titles in docs
URL: https://github.com/apache/camel/pull/2714
Accordng to issue
[12708](https://issues.apache.org/jira/browse/CAMEL-12708), created by
@tadayosi.
Changes where made, using [AsciiDoc
plugin](https://plugins.jetbrains.com/plugin/7391-asciidoc). By the way, plugin
marked old-style headers as warnings.
Few bugs were found and fixed: there were with extra "^", "~", "+".
Issue can be closed.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
Issue Time Tracking
-------------------
Worklog Id: (was: 186334)
Time Spent: 10m
Remaining Estimate: 0h
> We should use atx-style section titles in docs
> ----------------------------------------------
>
> Key: CAMEL-12708
> URL: https://issues.apache.org/jira/browse/CAMEL-12708
> Project: Camel
> Issue Type: Improvement
> Components: documentation
> Reporter: Tadayoshi Sato
> Priority: Major
> Time Spent: 10m
> Remaining Estimate: 0h
>
> [https://asciidoctor.org/docs/asciidoc-recommended-practices/#section-titles]
> Currently many docs in Camel uses the Setext style for section headings:
> {code:java}
> Architecture
> ~~~~~~~~~~~~
> {code}
> However this style has at least a couple of problems:
> # It requires the exactly same number of underline characters as the title
> text; otherwise it renders poorly
> # It is not very intuitive to know the level of a section
> As some docs already use it, we should use the Atx style all over the docs
> instead:
> {code:java}
> === Architecture
> {code}
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
