Skip to content

FPA Docs Management

Jump to bottom
Russ Winter edited this page Jun 10, 2020 · 2 revisions

This site utilises the Github Pages infrastructure and basic jekyll structure.

Forum Post Assistant Documentation site

Pages are basic HTML & CSS making use of the following frameworks;

 

Managing & Editing FPA Docs

The FPA Docs GH-Pages website content is basic HTML with styling and layout delivered through Bootstrap 4 and site structure making use of Jekyll through the Github Pages infrastructure.

A knowledge of Jekyll is not required to edit textual content, but a basic knowledge of HTML and Bootstrap classes is needed to appropriately style and layout any content.

 

Site (Repository) Structure

Folder/File Purpose Description
_includes/ jekyll content includes page content snippets to be included in main pages
_includes/abc_xyz.html html content includes section content snippets to be included in main pages (refer table below)
_layouts/ jekyll page layout templates reuseable page layout templates
_layouts/adminguide.html jekyll base page layout template for admin-guide page basic page layout specific to /admin-guide/ page
_layouts/default.html jekyll base page layout template for default pages layout specific to default pages & home page
admin-guide/ Admin Guide documention folder
admin-guide/index.html jekyll content layout template for admin-guide Admin Guide content layout template
assets/ local flie asset storage
assets/css/ custom css Bootstrap overrides and basic styling
assets/images/ site images
assets/project-files/ site related master file archives
.gitignore
LICENSE GPL-2.0
README .md repository introduction content markdown formatted file to display repository introduction
_config.yml jekyll site configuration
favicon.ico
index.html jekyll content layout template for default pages default & home page content layout template

 

_includes/ File Naming Conventions & Purpose

Example filename : adminguide_docdelete.html

<page> <content-section> <sidebar> <file-format> Purpose/Description
adminguide_ docdelete .html main "Delete FPA" content
Admin Guide Delete FPA html

 

Example filename : adminguide_docdelete_tips.html

<page> <content-section> <sidebar> <file-format> Purpose/Description
adminguide_ docdelete _tips .html sidebar "Delete FPA" content
Admin Guide Delete FPA html

 

Example filename : default_quickstartguide.html

<page> <content-section> <sidebar> <file-format> Purpose/Description
default_ quickstartguide .html main "Quick Start" content
Default Page Quick Start Guide html

 

Example filename : common_footer.html

<page> <content-section> <sidebar> <file-format> Purpose/Description
common_ footer .html footer "Copyright & Legals" content
All Pages Footer html

 

Page And Content Associations

Filename Associate Page Page Location/Content Area
adminguide_docdelete.html Admin Guide Delete FPA section, content
adminguide_docdelete_tips.html Admin Guide Delete FPA section, Tips & Hints sidebar
adminguide_docdownloadinstall.html Admin Guide Download & Install section, content
adminguide_docdownloadinstall.html Admin Guide Download & Install section, Tips & Hints sidebar
adminguide_docindex.html Admin Guide Page Section Index, content
adminguide_docintro.html Admin Guide Introduction section, content
adminguide_docrun.html Admin Guide Access & Generate Posts section, content
adminguide_docrun_tips.html Admin Guide Access & Generate Posts section, Tips & Hints sidebar
adminguide_docsecurity.html Admin Guide Security Implications section, content
adminguide_docsettings.html Admin Guide Options & Settings section, content
adminguide_docsettings_tips.html Admin Guide Options & Settings section, Tips & Hints sidebar
adminguide_docunderstand.html Admin Guide Understanding Output section, content
adminguide_docunderstand_tips.html Admin Guide Understanding Output section, Tips & Hints sidebar
adminguide_header.html Admin Guide Header/Masthead section, content
adminguide_meta.html Admin Guide head section, metadata
adminguide_nav.html Admin Guide navbar menu section, navbar
default_guidechoice.html Default Page Quick/Admin Guide Choice section, content
default_header.html Default Page Header/Masthead section, content
default_meta.html Default Page head section, metadata
default_nav.html Default Page navbar menu section, navbar
default_quickstartguide.html Default Page Quick Start Guide section, content
common_footer.html All Pages Footer section, content
common_head.html All Pages head section, meta & links
common_notices.html All Pages Eratta & Notices section, content
common_scripts.html All Pages end of body section, js, scripts & links

 

Sample file contents

  <div class="card border-0 w-100">
      <h3 class="card-title text-info ml-3 my-0 py-1 px-2 bg-light border-info border-bottom">
          <i class="material-icons-outlined mis32" style="vertical-align:sub;">chrome_reader_mode</i>
          Understanding FPA Output
      </h3>
      <div class="card-body">
          <p class="card-text text-size-md">Work-in-Progress</p>
      </div>
  </div><!-- /.card -->

 

Clone this wiki locally