redhat-documentation / community-collaboration-guide

A Red Hat guide to assist enterprise projects in collaborating with upstream communities on documentation.
https://redhat-documentation.github.io/community-collaboration-guide/
Creative Commons Attribution Share Alike 4.0 International
17 stars 20 forks source link

Add section explaining AsciiDoc attribute files #76

Closed inoxx03 closed 6 years ago

inoxx03 commented 6 years ago

The content for this section should briefly explain:

Please feel free to add content suggestions for useful information that the chapter should include, if anything comes to your mind:)

ncbaratta commented 6 years ago

Looks like we might have this already in the guide: https://redhat-documentation.github.io/community-collaboration-guide/#ccg-asciidoc-attributes but it could use some beefing up probably.

inoxx03 commented 6 years ago

@nengard Right, my bad:) I completely skipped over that one and missed it when checking the guide.I'll go over the existing content to see where and how it can be improved:)

ncbaratta commented 6 years ago

No worries! I did too! I'm the one who said we didn't have it in the guide yet :)

jenmalloy commented 6 years ago

+1 to @inoxx03 suggestions, in particular how to "build out" link URLs with replaceables/variables. It's a great way to avoid hardcoding and really powerful for that reason.

Also, how to handle the product attributes file would be useful, since that's where things can get tricky if you are mirroring the upstream repo downstream. Since I'm working through this right now, I can write up my findings after I get it all figured out.

inoxx03 commented 6 years ago

I've made some additions to the AsciiDoc chapter. The changes are introduced by PR #94.