Invoke-Documentation

Started out from Damien Sorel's jekyll-bootstrap-doc

The aim is to centralise all (technical) documentation for all projects of Invoke-Automation using this site.

Running the site localy

Checking out a repo with submodules

for Git 2.13 and later you can clone everything using

git clone --recurse-submodules https://github.com/Invoke-Automation/Invoke-Documentation.git

If you already cloned and forgot or if you are using older versions of Git

git clone https://github.com/Invoke-Automation/Invoke-Documentation.git
cd Invoke-Automation
git submodule update --init --recursive

Install Jekyll

Use the Jekyll documentation

TL;DR for Windows:

choco install ruby -y
gem install jekyll
gem install bundler

Run the site

bundle exec jekyll serve

Adding a project

To Add a project to this site the following steps need to be taken:

1. Add the project to the \_data\projects.yml

- name: ProjectName
  description: ProjectDescription
  github: ProjectGitHubURL
  index: ProjectIndex
  path: /projects/ProjectName

2. Add the Project repo as submodule to this repo

git submodule add ProjectGitURL.git projects/ProjectName

To make the README file visible on the site the README.md file needs to start with the following yml header:

---
URL: URLToTheREADMEFile
index: 0
---

Updating a project

To update a projects documentation the documentation first needs to be available in the master branch of that project. If the master branch of a project is updated these changes should be pulled into this repo:

git submodule foreach git pull origin master