From edbbe4aea36517fbb54939fc2995fb859048df90 Mon Sep 17 00:00:00 2001 From: Vincent Tam Date: Thu, 24 Jan 2019 21:15:07 +0100 Subject: [PATCH 1/3] Corrected Staticman v3 info --- docs/_docs/05-configuration.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/docs/_docs/05-configuration.md b/docs/_docs/05-configuration.md index 5fd024613e9c..673dc58123da 100644 --- a/docs/_docs/05-configuration.md +++ b/docs/_docs/05-configuration.md @@ -392,7 +392,19 @@ Transform user comments into `_data` files that live inside of your GitHub repos ###### Staticman v3 -Due to the support for GitLab, the URL scheme has been changed. Bewteen `v3` and `/entry`, one needs to input a Git service provider (either `github` or `gitlab`). Apart from that, the setup for GitHub remains the same. +Due to the support for GitLab, the URL scheme has been changed. Bewteen `v3/entry/` and `/{your Git username}`, one needs to input a Git service provider (either `github` or `gitlab`). For example + + https://{your Staticman v3 API}/v3/entry/github/{your Git username}/{your repository name}/... + +```yaml +# _config.yml (defaults) +repository : # Git username/repo-name e.g. "mmistakes/minimal-mistakes" +comments: + provider : "staticman_v2" + staticman: + branch : "master" + endpoint : https://{your Staticman v3 API}/v3/entry/github/ +``` ###### Staticman v2 From 517dfdee7e7a369880d872a0fb228405283fc6d5 Mon Sep 17 00:00:00 2001 From: Vincent Tam Date: Thu, 24 Jan 2019 21:19:13 +0100 Subject: [PATCH 2/3] Added a link to eduardoboucas/staticman#219 --- docs/_docs/05-configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_docs/05-configuration.md b/docs/_docs/05-configuration.md index 673dc58123da..67ea0bb7ce80 100644 --- a/docs/_docs/05-configuration.md +++ b/docs/_docs/05-configuration.md @@ -392,7 +392,7 @@ Transform user comments into `_data` files that live inside of your GitHub repos ###### Staticman v3 -Due to the support for GitLab, the URL scheme has been changed. Bewteen `v3/entry/` and `/{your Git username}`, one needs to input a Git service provider (either `github` or `gitlab`). For example +Due to the [support for GitLab](https://github.com/eduardoboucas/staticman/pull/219), the URL scheme has been changed. Bewteen `v3/entry/` and `/{your Git username}`, one needs to input a Git service provider (either `github` or `gitlab`). For example https://{your Staticman v3 API}/v3/entry/github/{your Git username}/{your repository name}/... From 0d760650ff1b3f38ab3d64cd908c3621c5fd8ec6 Mon Sep 17 00:00:00 2001 From: Michael Rose Date: Sun, 27 Jan 2019 20:07:52 -0500 Subject: [PATCH 3/3] Fix typo --- docs/_docs/05-configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_docs/05-configuration.md b/docs/_docs/05-configuration.md index 67ea0bb7ce80..49f94eec3160 100644 --- a/docs/_docs/05-configuration.md +++ b/docs/_docs/05-configuration.md @@ -392,7 +392,7 @@ Transform user comments into `_data` files that live inside of your GitHub repos ###### Staticman v3 -Due to the [support for GitLab](https://github.com/eduardoboucas/staticman/pull/219), the URL scheme has been changed. Bewteen `v3/entry/` and `/{your Git username}`, one needs to input a Git service provider (either `github` or `gitlab`). For example +Due to the [support for GitLab](https://github.com/eduardoboucas/staticman/pull/219), the URL scheme has been changed. Between `v3/entry/` and `/{your Git username}`, one needs to input a Git service provider (either `github` or `gitlab`). For example https://{your Staticman v3 API}/v3/entry/github/{your Git username}/{your repository name}/...