bcgov / bcgov/DITP-DevOps

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

Open
#17 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
Shell
Stars
2
Forks
8
PR merge metrics
No merged PRs in 30d

Description

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](https://pages.github.com/) or as a [GitHub wiki](https://docs.github.com/en/communities/documenting-your-project-with-wikis), 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](https://pages.github.com/)
- [Quickstart for GitHub Pages](https://docs.github.com/en/pages/quickstart)
- [bcgov/common-service-showcase](bcgov/common-service-showcase)
- GitHub Pages repository
- [Updating Documents Guide](https://github.com/bcgov/von/blob/master/docs/_how_to/updating-docs.md) from our old vonx.io site (the old site was a GitHub pages site).

### GitHub Wiki:
- [GitHub wiki](https://docs.github.com/en/communities/documenting-your-project-with-wikis)
- [Common Service Showcase Wiki](https://github.com/bcgov/common-service-showcase/wiki)
- [awesome-github-wiki](https://github.com/MyHoneyBadger/awesome-github-wiki)
- Links to example wikis, tips, and tricks.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.