docs: Reorganize to better handle GitHub Pages (#48)

Co-authored-by: Prasad Tengse <tprasadtp@users.noreply.github.com>
tprasadtp · May 16, 2021 · 96bdfc8 · 96bdfc8
1 parent a0ba4ee
commit 96bdfc8
Show file tree

Hide file tree

Showing 13 changed files with 51 additions and 73 deletions.
diff --git a/.chglog/CHANGELOG.md.tpl b/.chglog/CHANGELOG.md.tpl
@@ -1,6 +1,4 @@
-<!-- markdownlint-disable MD033 -->
-
-## Changelog
+# Changelog
 
 {{ if .Versions -}}
 {{ if .Unreleased.CommitGroups -}}

diff --git a/.chglog/RELEASE_NOTES.md.tpl b/.chglog/RELEASE_NOTES.md.tpl
@@ -1,6 +1,4 @@
-<!-- markdownlint-disable MD033 -->
-
-## Release Notes
+# Release Notes
 
 {{ if .Versions -}}
 {{ range .Versions -}}

diff --git a/.github/ISSUE_TEMPLATE/connectivity-issue.md b/.github/ISSUE_TEMPLATE/connectivity-issue.md
@@ -5,7 +5,7 @@ about: Use this template for connectivty issues.
 
 ## Debugging with debugging compose file
 
-- [ ] I have tried debugging with compose file provided as mentioned in [TROUBLESHOOTING](./TROUBLESHOOTING.md).
+- [ ] I have tried debugging with compose file provided as mentioned in [TROUBLESHOOTING](https://tprasadtp.github.io/protonvpn-docker/docs/troubleshooting/).
 - [ ] I have attached output/outcome of debugging steps below
 
 <!-- Please Provide details on your errors when you tried debugging with provided compose file -->
@@ -34,6 +34,6 @@ about: Use this template for connectivty issues.
 ## Redacted PII & Credential validation
 
 - [ ] I have redacted any personally identifying information like public IP address, hostnames, usernames and passwords if they are present in the output.
-- [ ] I have verfied that my VPN credentials are valid.
+- [ ] I have verified that my VPN credentials are valid.
 
-[compose file]: https://raw.githubusercontent.com/tprasadtp/protonvpn-docker/master/k8s/docker-compose.yml
+[compose file]: https://raw.githubusercontent.com/tprasadtp/protonvpn-docker/master/docs/troubleshooting/docker-compose.yml
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -62,7 +62,12 @@ jobs:
       - name: Generate Changelog
         run: |
           make changelog
-          cat CHANGELOG.md
+          cat docs/changelog.md
+
+      - name: Generate Release notes
+        run: |
+          make release-notes
+          cat RELEASE_NOTES.md
 
       - name: Build snapshot
         run: make snapshot

diff --git a/Makefile b/Makefile
@@ -57,7 +57,7 @@ changelog: ## Generate changelog
 		--debug \
 		--oldest-tag 4.0.0 \
 		--footer-file $(REPO_ROOT)/.chglog/FOOTER.md \
-		--output $(REPO_ROOT)/CHANGELOG.md \
+		--output $(REPO_ROOT)/docs/changelog.md \
 		--changelog
 
 .PHONY: release-notes

diff --git a/README.md b/README.md
@@ -13,53 +13,16 @@
 
 <!-- CI Badges -->
 
-<p align="center">
-
-  <a href="https://github.com/tprasadtp/protonvpn-docker/actions?workflow=build" target="_blank" rel="noreferrer">
-    <img src="https://github.com/tprasadtp/protonvpn-docker/workflows/build/badge.svg" align="center" alt="action-build">
-  </a>
-
-  <a href="https://github.com/tprasadtp/protonvpn-docker/actions?workflow=release" target="_blank" rel="noreferrer">
-    <img src="https://github.com/tprasadtp/protonvpn-docker/workflows/release/badge.svg"align="center" alt="action-release">
-  </a>
-
-  <a href="https://github.com/tprasadtp/protonvpn-docker/actions?workflow=security" target="_blank" rel="noreferrer">
-    <img src="https://github.com/tprasadtp/protonvpn-docker/workflows/security/badge.svg"align="center" alt="action-security">
-  </a>
-
-</p>
-
-<!-- Version and Release Badges -->
-
-<p align="center">
-
-  <a href="https://github.com/tprasadtp/protonvpn-docker/releases/latest" target="_blank" rel="noreferrer">
-    <img src="https://img.shields.io/github/v/tag/tprasadtp/protonvpn-docker?label=version&sort=semver&logo=semver&color=7f50a6&labelColor=3a3a3a" align="center" alt="releases">
-  </a>
-
-  <a href="https://goreleaser.com" target="_blank" rel="noreferrer">
-    <img src="https://img.shields.io/badge/powered--by-goreleaser-7f50a6?logo=semver&labelColor=3a3a3a" align="center" alt="powerd-by">
-  </a>
-
-</p>
-
-
-<!-- Other Badges -->
-
-<p align="center">
-
-  <a href="https://github.com/tprasadtp/protonvpn-docker/blob/master/LICENSE" target="_blank" rel="noreferrer">
-    <img src="https://img.shields.io/github/license/tprasadtp/protonvpn-docker?logo=github&labelColor=3A3A3A" align="center" alt="license">
-  </a>
-
-  <img src="https://ga-beacon.prasadt.com/UA-101760811-3/github/gfilt" align="center" alt="action-release">
-
-</p>
-
+[![build](https://github.com/tprasadtp/protonvpn-docker/actions/workflows/build.yml/badge.svg)](https://github.com/tprasadtp/protonvpn-docker/actions/workflows/build.yml)
+[![release](https://github.com/tprasadtp/protonvpn-docker/actions/workflows/release.yml/badge.svg)](https://github.com/tprasadtp/protonvpn-docker/actions/workflows/release.yml)
+[![security](https://github.com/tprasadtp/protonvpn-docker/actions/workflows/security.yml/badge.svg)](https://github.com/tprasadtp/protonvpn-docker/actions/workflows/security.yml)
+[![releases](https://img.shields.io/github/v/tag/tprasadtp/protonvpn-docker?label=version&sort=semver&logo=semver&color=7f50a6&labelColor=3a3a3a)](https://github.com/tprasadtp/protonvpn-docker/releases/latest)
+[![license](https://img.shields.io/github/license/tprasadtp/protonvpn-docker?logo=github&labelColor=3A3A3A)](https://github.com/tprasadtp/protonvpn-docker/blob/master/LICENSE)
+![analytics](https://ga-beacon.prasadt.com/UA-101760811-3/github/protonvpn-docker)
 
 ## Docker Registries
 
-Images are published on [GitHub Container Registry][ghcr].
+- Images are published on [GitHub Container Registry][ghcr].
 
 ## Environment Variables
 
@@ -170,9 +133,14 @@ networks:
 
 There is a `healthcheck` script available under /usr/local/bin (Added in 2.2.2-hotfix2). It will use `https://ipinfo.io` to verify the country to which VPN is connected. By default service will keep checking every `PROTONVPN_CHECK_INTERVAL` _(default = 60)_ seconds using the same api endpoint, script is only added for convenience.
 
+## Changelog
+
+- This project follows [Semantic Versioning 2.0.0](https://semver.org/)
+- Changelogs can be found at [changelog](./docs/changelog.md)
+
 ## Troubleshooting
 
-See [Troubleshooting](./TROUBLESHOOTING.md)
+See [Troubleshooting](./docs/troubleshooting.md).
 
 ## Known issues
 
@@ -190,7 +158,7 @@ By default instance metadata IPs which are commonly used on cloud environments a
 
 ## Kubernetes
 
-You may need to tweak your `PROTONVPN_EXCLUDE_CIDRS` to exclude your PodCIDR and ServiceCIDR. You also **MUST** disable dns leak protection. for more info see [k8s/README.md](./k8s/README.md).
+You may need to tweak your `PROTONVPN_EXCLUDE_CIDRS` to exclude your PodCIDR and ServiceCIDR. You also **MUST** disable dns leak protection. for more info see [docs/kubernetes.md](./docs/kubernetes.md).
 
 [dockerhub]: https://hub.docker.com/r/tprasadtp/protonvpn
 [ghcr]: https://ghcr.io/tprasadtp/protonvpn

diff --git a/_config.yml b/_config.yml
@@ -14,6 +14,8 @@ search_enabled: true
 
 # Misc
 permalink: pretty
+color_scheme: dark
+
 
 # Aux links for the upper right navigation
 aux_links:

diff --git a/CHANGELOG.md → docs/changelog.md b/CHANGELOG.md → docs/changelog.md
@@ -1,17 +1,26 @@
-<!-- markdownlint-disable MD033 -->
-
-## Changelog
+# Changelog
 
 <a name="unreleased"></a>
 ## [Unreleased]
 
+### 📖 Documentation
+- Reorganize to better handle GitHub Pages ([ad47fde](https://github.com/tprasadtp/protonvpn-docker/commit/ad47fdee4a07956515b3380fd64c60ac99bcd695))
+- Enable Github pages and add troubleshooting docs ([a0ba4ee](https://github.com/tprasadtp/protonvpn-docker/commit/a0ba4eec74f5b8ab89db7ed77aae30f786404e59))
+- Update debugging compose file ([c127608](https://github.com/tprasadtp/protonvpn-docker/commit/c1276081a57e737a0b549abc3b839ae4cdca0610))
+- Fix docker logo URL in README ([4cf3b0d](https://github.com/tprasadtp/protonvpn-docker/commit/4cf3b0d189c6a493d8d75c440a884eb58c6c64f2))
+
 ### 🚧 Maintanance
+- Update templates ([51d120c](https://github.com/tprasadtp/protonvpn-docker/commit/51d120c312860930d35efa9005ac3870c530a6d0))
+- Update templates ([c122bed](https://github.com/tprasadtp/protonvpn-docker/commit/c122bed299f910c197fb90f1d21523d22849ed17))
 - **automation:** Allow automerge of docker image updates done via dependabot ([74ee95e](https://github.com/tprasadtp/protonvpn-docker/commit/74ee95e83ebdd56e4215fcd83f79c4ddc6df8783))
 - **changelog:** Update changelog emojis to follow common snippets ([91cd108](https://github.com/tprasadtp/protonvpn-docker/commit/91cd108bc2979984ce24d279080cf39ca7083cd1))
 
 ### 🤖 CI/CD & Automation
 - Checkout tag corresponding to latest release, before doing scheduled security scan to help populate required fields for codeql action ([842e834](https://github.com/tprasadtp/protonvpn-docker/commit/842e8348be330743ab708d081a61440c7c0e7c56))
+- **deps:** bump aquasecurity/trivy-action from 0.0.16 to 0.0.17 ([#47](https://github.com/tprasadtp/protonvpn-docker/issues/47)) ([a995116](https://github.com/tprasadtp/protonvpn-docker/commit/a995116c8077e8fa2970c5450109b412dff14e06))
+- **deps:** bump aquasecurity/trivy-action from 0.0.15 to 0.0.16 ([#46](https://github.com/tprasadtp/protonvpn-docker/issues/46)) ([7e90b7d](https://github.com/tprasadtp/protonvpn-docker/commit/7e90b7d06dcbd2d85e06393cd109c7575d36fd2d))
 - **deps:** bump aquasecurity/trivy-action from 0.0.14 to 0.0.15 ([#44](https://github.com/tprasadtp/protonvpn-docker/issues/44)) ([a19d7aa](https://github.com/tprasadtp/protonvpn-docker/commit/a19d7aa4aae72f7d883f6e4b6ea3f2f036bd3a9c))
+- **kodiak:** Remove default block on GH-Actions dependency updates ([b5172d4](https://github.com/tprasadtp/protonvpn-docker/commit/b5172d45934d5438a9f9a8007b25ec3c0291d9cf))
 
 
 <a name="4.2.1"></a>

diff --git a/k8s/docker-compose.yml → docs/docker-compose.yml b/k8s/docker-compose.yml → docs/docker-compose.yml
@@ -1,3 +1,5 @@
+# This docker compose file is intended for
+# troubleshooting purposes ONLY.
 version: '3.4'
 services:
   protonvpn:

diff --git a/k8s/README.md → docs/kubernetes.md b/k8s/README.md → docs/kubernetes.md
@@ -9,7 +9,7 @@
   </a>
 </p>
 
-## Create a namespace or switch to namespace
+## Create a namespace or switch to existing namespace
 
 ```bash
 # CREATE
@@ -46,8 +46,10 @@ Please note that we are using Pod here. In real world scenario please use Deploy
 This is for ease of use as the application you may want to use with protonvpn will vary. also we are using service of type `NodePort` for simplicity.
 
 ```bash
-kubectl appy -f pod.yml
-kubectl apply -f service.yml
+# Create Pod
+kubectl create -f https://raw.githubusercontent.com/tprasadtp/protonvpn-docker/master/docs/pod.yml
+# Create service
+kubectl create -f https://raw.githubusercontent.com/tprasadtp/protonvpn-docker/master/docs/service.yml
 ```
 
 ## Verify
@@ -100,7 +102,7 @@ kubectl apply -f service.yml
     [Service - CHCK] OK!
     ```
 
-- check pylaod is accessible via nodeport
+- Check pylaod is accessible via nodeport
 
     ```bash
     kubectl get service

diff --git a/k8s/pod.yml → docs/pod.yml b/k8s/pod.yml → docs/pod.yml
diff --git a/k8s/service.yml → docs/service.yml b/k8s/service.yml → docs/service.yml
diff --git a/TROUBLESHOOTING.md → docs/troubleshooting.md b/TROUBLESHOOTING.md → docs/troubleshooting.md
@@ -1,11 +1,3 @@
-
----
-layout: default
-title: Troubleshooting
-permalink: /troubleshooting/
-nav_order: 5
----
-
 # Troubleshooting
 
 If you are unable to run the container as desired, please try the following before opening an issue
@@ -18,7 +10,7 @@ on GitHub.
 This depends on your shell. Please consult your shell's manpage/docs for how to export environment variables.
 1. Get your debugging [compose file][] and create a temporary folder required to save pyload downloads.
     ```bash
-    curl -sSfLO https://raw.githubusercontent.com/tprasadtp/protonvpn-docker/master/k8s/docker-compose.yml
+    curl -sSfLO https://raw.githubusercontent.com/tprasadtp/protonvpn-docker/master/docs/troubleshooting/docker-compose.yml
     mkdir -p ./downloads
     ```
 1. Try to run downloaded [compose file][]
@@ -38,3 +30,5 @@ This depends on your shell. Please consult your shell's manpage/docs for how to
 
 - Healthchecks use `ipinfo.io` service. If your DNS or gateway is blocking it, please add it to your exceptions.
 - If your are unable to do so, please open an issue so that we can find some alternatives.
+
+[compose file]: https://raw.githubusercontent.com/tprasadtp/protonvpn-docker/master/docs/docker-compose.yml