#7 Double Headings on pages.
Closed 5 years ago Opened 6 years ago by zoglesby.

Sections in the release notes have two headers.

I think removing the section with the header name would make it cleaner.

Example:
[[sect-modularity]] == Fedora Modularity

49B631DF-AA8E-45B2-B354-F40B20621299.jpeg

Comments from bex on https://pagure.io/fedora-docs/release-notes/issue/1

@zoglesby I'm on my phone so I haven't verified what I'm saying is what you're reporting, however I think thisnisnit. Asciibinder'sndefault template puts the menu text above the content, separated by a line. Fedora Docs, has by default used the same words for the first header and the menu text.
I believe we should decide if this is what we want or if we should modify one of them to be more expressive in their specific context. If we want to do this, let's open a ticket against https://pagure.io/fedora-docs/docs-fp-o
I believe the file to modify will be https://pagure.io/fedora-docs/docs-fp-o/blob/master/f/_templates/page.html.erb#_59
If we decide to modify it, we will also need to update the individual repos. I'd like to see is build a management program for that to limit duplicative PRs.

So .. some of what I wrote was wrong :)
The double header is because the template prints the first head it finds and then proceeds to render the page. If that first header is an h1 = header, then it is ommitted in the render and there is no double header effect. It appears our first headers are all h2 ==. I think the solution is going to lie in redoing the header levels. This needs to be explored a bit as it generates some warnings we need to think about.
This should definitely get moved over to docs-fp-o in my opinion as it affects all repos. @zoglesby if you have time to move it that would be great. Otherwise I'll try to do it when I have more time.


It seems like this requires potentially these changes:

  1. Convert all files to use an h1 as their top level header.
  2. Ensure there is a blank line between the h1 and any subsequent intro paragraphs
  3. Possibly fix includes to do appropriate header level advancement

I haven't had time to build a full test yet - but it seems promising.

A 4th option, we can just eliminate the printing of "article_title" in our page template.

Additionally, I've recently discovered this is caused by AsciiDoctor - not AsciiBinder. This means a configuration setting may or may not be appropriate here.

This bug is related to asciibinder. Please reopen if this remains true with antora where it is believed fixed.

Metadata Update from @bex:
- Issue status updated to: Closed (was: Open)

5 years ago

Login to comment on this ticket.

Metadata
Attachments 1