Create a "start here" guide for the DITP-DevOps team

[WadeBarnes]

As the starting point to more structured documentation for our team, create a "start here" guide to pull together the various documents and resources our team has for supporting our applications. This can start out as links and small guides to existing content to then be expanded from there.

We want to structure this as GitHub Pages or as a GitHub wiki, with a preference toward GitHub Pages for better presentation.

Resources:

Below are a few resources. Though you'll be able to google many more.

GitHub Pages:

• GitHub Pages
  • Quickstart for GitHub Pages
• bcgov/common-service-showcase
  • GitHub Pages repository
• Updating Documents Guide from our old vonx.io site (the old site was a GitHub pages site).

GitHub Wiki:

• GitHub wiki
• Common Service Showcase Wiki
• awesome-github-wiki
  • Links to example wikis, tips, and tricks.

[WadeBarnes]

@rajpalc7, if you go the GitHub pages route I would highly recommend containerizing the project for ease of local development and updates. Here is some information about Developing inside a Container with VSCode. I can help with this when the time comes.

[WadeBarnes]

Actually here is a blog about doing just that; VSCode, Docker, and Github Pages. There is also this repo that has settings for a gh-pages devcontainer; kosalanuwan/devcontainers

[WadeBarnes]

@rajpalc7, There are a number of DTS Resources you can link to in the DTS Resource Trello Board. You can access this board through the Review DTS Resources card in your personal DITP Onboarding Trello Board.