Welcome to the ACMEdoc Fab User Guide!

Here you will learn to develop great docs ACMEdoc Fab as a user.

The content above appears in all editions, but some of it is variable. Many of the strings (e.g., ACMEdoc Fab and even develop great docs, etc) are variables ({portal_product} and {user_verb}) are dynamically substituted with AsciiDoc attributes at build time. The content is included from a common file, like so:

 include::includes/intro_portal_common.adoc[]

Our standard offering is pretty simple, quite by design. It has some feature limitations that we’ll tease you with throughout this manual, but there’s still quite a bit you can do with it.

The above text is from a dynamically included file using:

 include::portal/intro_portal_{portal_slug}.adoc[]

Where {portal_slug} is a variable defined in a block of a YAML file (_configs/portals.yml) that is only passed to one designated portal during the build config file (_configs/build-docs.yml), where it is designated as data: _data/portals.yml:portal-2.

This document contains lots of jargon. See the Jargon Guide if you get lost.

Copyright © 2018 ACMEdocOps Collective