Add mkdocs-material docs gen and include CI docs (review)

rog-golang-buddies / golang-template-repository

Kickstarter repository for a golang service

Apache License 2.0

17 stars 7 forks source link

Add mkdocs-material docs gen and include CI docs (review) #30

Closed haani-niyaz closed 2 years ago

haani-niyaz commented 2 years ago

Hi @shukra-in-spirit @vancanhuit , I've raised this PR for review on:

Documentation structure
Quickstart content
CI pages structure
CI content for gitleaks, pre-commit, mkdocs-material and golangci-lint

The documentation on publish will look similar to: https://haani-niyaz.github.io/golang-template-repository/

Closes #21 and #28.

Required actions:

[x] Proof read content
[x] Enable gh-pages in template repo settings as mentioned in #21
[x] Add Sonarqube CI docs
[x] Reconcile with #23

@AlvinKuruvilla, there was an urgency to finish this piece of work so I've stepped in. Happy to discuss with you if required.

jeffy-mathew commented 2 years ago

since this is related to docs. shall we use https://opencollective.com/vale to do a copy check? https://github.com/errata-ai/vale-action - seems helpful in GitHub actions context

haani-niyaz commented 2 years ago

since this is related to docs. shall we use https://opencollective.com/vale to do a copy check? https://github.com/errata-ai/vale-action - seems helpful in GitHub actions context

This definitely looks interesting. We should have a story to explore it :)

For the purpose of this MR though, a more technical documentation review is required to validate if the information is helpful for repo owners to get started.