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
80 stars 67 forks source link

Add image with title and alt text to concept module #172

Closed oraNod closed 2 years ago

oraNod commented 2 years ago

During recent review with Lorena and Ingrid, I got feedback about adding a title and alt text to images. Specific feedback comment: "This diagram also needs a name and title."

If my asciidoc source is image::image.png[My image] then what markup should I add?

I can go refer to the asciidoc user's manual and find the tags I need but I'd rather have that in the template for concept modules as there should be guidelines.

sterobin commented 2 years ago

@oraNod I've reported the user of the above content to GitHub and have hidden the comment since it's highly offensive and concerning. I chose not to delete it in case it's needed for record. I also got @bergerhoffer to help me block the user. Since she's one of the "Owner" users of the redhat-docs space, figured it'd work better for our whole space. When I block the user, only blocks them for repos for which I'm the "Owner" apparently. I saw that you're an owner of this space too, but Andrea was just in my same timezone. Sorry this happened, Don.

emmurphy1 commented 2 years ago

@adahms, we added some instructions about images and alt text to the concept module template.