Documentation

This section is where the user documentation for your product, project, or delivery lives - all the information your users need to understand and successfully use your product.

For large documentation sets we recommend adding content under the headings in this section, though if some or all of them don’t apply to your product feel free to remove them or add your own. You can see an example of a smaller Docsy documentation site in the Docsy User Guide, which lives in the Docsy theme repo if you’d like to copy its docs section.

Other content such as marketing material, case studies, and community updates should live in the About and Community pages.

Find out how to use the Docsy theme in the Docsy User Guide. You can learn more about how to organize your documentation (and how we organized this site) in Organizing Your Content

In order to contribute to the documentation you can do so by editting the files in the Ignition-Group-Open-Source-Contrib/igengdoc repository in Azure DevOps.

Click here to access it. You will need a GitHub account, and be added to the Ignition-Group-Open-Source-Contrib group. Speak to Russell, Ben, or Simmy to add you if you don’t have this yet.

We reccommend using Visual studio code to edit and maintain the repository. Alternatively you can edit directcly in the online GitHub repo.

Before Cloning the repo on your machine, please download and install git:

NEVER COMMIT TO THE MASTER BRANCH DIRECTLY - ALWAYS USE A PULL REQUEST FROM YOUR OWN BRANCH

When you commit your changes the site will automatically get built and deployed to this URL.

Things to watch out for

  • Each new folder needs a _index.md file
  • The folder and file names are case sensitive
  • Images cannot have spaces in the names
  • Documentation and Blog files are seperate folders

Support

Ignition Technology Support, Incident management & Escalations

Processes and flows

Our internal Processes, flows and service level agreements

Standards

Ignition Technology Development Standards & Best Practice

Deployment Guides

Operationalise your development and show your user how to work through some end to end examples…

engAIge Table of Contents

Below are links that will give you access to everything you need to know about engAIge and how it can benefit you to grow your business.

pAIment Table of Contents

pAIment is our new in house billing and collection system. It replaces our previously largely manual billing integrations with many integrations to 3rd party vendors. We have buitl a system which manages the list of subscriptions and bills the customers on a recurring basis. pAIment also acceepts new subscriptions that will need to be billed via various input mechanisms such as, API, UI, Batch.

Agent Desktop

The outbound sales platform for local and international campaigns

Software Development

Anything Software Development related.

Digital Marketing

Anything Digital Marketing related.

Tools

Details of the microservices…

Last modified January 19, 2022: Fixing the build (94e4ef1)