search

redhat-documentation / modular-docs

Modular Documentation Project provides guidelines and examples for writing technical documentation using a modular framework.
Creative Commons Attribution Share Alike 4.0 International
82 stars 68 forks source link

Can we remove [role="_abstract"] from the templates? #184

Closed emmurphy1 closed 2 years ago

emmurphy1 commented 2 years ago

The role="_abstract" tag was added to the modular templates for Pantheon V2 in order to identify the first paragraph of text after the title for key words used in Google searches. Mike McKiernan reported that this tag wasn't actually required according to engineers that he spoke to. The Jupiter team has confirmed that the tag will not be required for Jupiter.

There is a small number documents that are published through PV2. For this reason, we want to be sure the tag isn't required before we remove it from the templates.

I reached out to Christine Bryan and she asked me to created a jira for this issue:

https://issues.redhat.com/browse/CCSOPS-1272

emmurphy1 commented 2 years ago

Confirmed with Lisa Davidson through the following jira that the role abstract tag is not required for PV2 and therefore we can remove it from templates: https://issues.redhat.com/browse/CCSOPS-1272

emmurphy1 commented 2 years ago

I've created this PR and removed the abstract tag from the templates; https://github.com/redhat-documentation/modular-docs/pull/185

emmurphy1 commented 2 years ago

@adahms this one is important. We removed the abstract tag and added an instruction in the templates to be sure have a line between the title and the first paragraph.