-
Copies
content/
to_build/
, without carrying the parent directory. -
Copies
theme/
to_build/
. -
Performs the first round of product-data parsing to build two structurally vital files, sourcing data in
data/product.yml
.-
Builds the page metadata (
_build/includes/_built_page-meta.adoc
) included in all HTML and PDF exposures of topics, but only relevant as Jekyll page metadata at this time. -
Builds the metadata file
_build/includes/_built_page-meta.adoc
based on the user stories inproduct.yml
, looping over them as directed in_templates/liquid/page-meta.asciidoc
. The topics metadata is drawn from this preprocessed file (_build_page-meta.adoc
).
-
-
Draws data from the `data/meta.yml`and parses it as follows:
-
Builds
_build/includes/_built_company-info.adoc
pressed with the template_templates/liquid/company-info.asciidoc
.
-
-
Draws data from the `data/terms.yml`and parses it as follows:
-
Builds
_build/includes/_built_terms.adoc
pressed with the template_templates/liquid/terms.asciidoc
, to be included into the 'jargon guide'.
-
-
Draws data from the `NOTICE`and parses it as follows:
-
Builds
_build/includes/_built_dependencies_table.adoc
pressed with the template_templates/liquid/dependencies.asciidoc
, using a regular expression pattern to extract data from the plaintext source file before passing the results to Liquid.
-
-
Copies
_build/theme
to_build/site
. -
Copies
data
to_build/
. -
Draws data from the
data/product.yml
, to have user-stories content in convenient includes, and parses it as follows:-
Builds
_build/includes/_built_user-stories-bulleted-by-role.adoc
pressed with the template_templates/liquid/user-stories-bulleted-by-role.asciidoc
. -
Builds
_build/includes/_built_user-stories-full.adoc
pressed with the template_templates/liquid/user-stories-full.asciidoc
.
-
-
Draws data from the
data/product.yml
, to build lists of files to exclude from a given guide’s Jekyll build (otherwise it would grab all ourtopics/
source files for every guide) , and parses it as follows:-
Builds
_build/data/excludes-docpro.yml
pressed with the template_templates/liquid/excludes-docpro.yaml
. -
Builds
_build/data/excludes-admin.yml
pressed with the template_templates/liquid/excludes-admin.yaml
. -
Builds
_build/data/excludes-dev.yml
pressed with the template_templates/liquid/excludes-dev.yaml
.
-
-
Draws data from the `data/meta.yml`and parses it as follows:
-
Builds
_build/data/topnav.yml
pressed with the template_templates/liquid/topnav.yaml
, the source file for the top navigation bar.
-
-
Draws data from the
data/product.yml
, the source files for the guide-specific sidebars, and parses it as follows:-
Builds
_build/data/sidebars/docpro.yml
pressed with the template_templates/liquid/sidebar-docpro.yaml
. -
Builds
_build/data/sidebars/admin.yml
pressed with the template_templates/liquid/sidebar-admin.yaml
. -
Builds
_build/data/sidebars/dev.yml
pressed with the template_templates/liquid/sidebar-dev.yaml
.
-
-
Using the index file
_build/portal-index.adoc
as a map…-
Calls on Asciidoctor/Prawn to generate a PDF file
_build/docs/docpro-guide.pdf
. -
Uses Jekyll config files:
-
_configs/jekyll-global.yml
-
_configs/jekyll-guides-common.yml
-
_configs/jekyll-guide-1.yml
-
_build/data/excludes-docpro.yml
to generate a static site at
_build/site
, the static files for the 'docpro' web portal. -
-
-
Using the index file
_build/portal-index.adoc
as a map…-
Calls on Asciidoctor/Prawn to generate a PDF file
_build/docs/admin-guide.pdf
. -
Uses Jekyll config files:
-
_configs/jekyll-global.yml
-
_configs/jekyll-guides-common.yml
-
_configs/jekyll-guide-2.yml
-
_build/data/excludes-admin.yml
to generate a static site at
_build/site
. -
-
-
Using the index file
_build/portal-index.adoc
as a map…-
Calls on Asciidoctor/Prawn to generate a PDF file
_build/docs/dev-guide.pdf
. -
Uses Jekyll config files:
-
_configs/jekyll-global.yml
-
_configs/jekyll-guides-common.yml
-
_configs/jekyll-guide-3.yml
-
_build/data/excludes-dev.yml
to generate a static site at
_build/site
. -
-
-
Copies
_build/theme
to_build/site
. -
Copies
_build/assets
to_build/site
. -
Copies
_build/docs
to_build/site
. -
Copies
content/index.html
to_build/site
.
Created
February 23, 2018 03:24
-
-
Save briandominick/6be4f6f01997ea1763b4bcfdb0550310 to your computer and use it in GitHub Desktop.
A programmatically generated narrative of a preconfigured build operation in LiquiDoc.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment