From 877bc26078c888abaf8bc73da38206ba4dd7b97a Mon Sep 17 00:00:00 2001 From: David Mehren Date: Mon, 11 Jan 2021 11:54:22 +0100 Subject: Docs: Replace `:smile` with actual 😃 emoji Signed-off-by: David Mehren --- docs/content/guides/auth/gitlab-self-hosted.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/content/guides/auth/gitlab-self-hosted.md') diff --git a/docs/content/guides/auth/gitlab-self-hosted.md b/docs/content/guides/auth/gitlab-self-hosted.md index fc655ac5..1205b487 100644 --- a/docs/content/guides/auth/gitlab-self-hosted.md +++ b/docs/content/guides/auth/gitlab-self-hosted.md @@ -1,6 +1,6 @@ # GitLab (self-hosted) -*Note:* This guide was written before the renaming. Just replace `HackMD` with `HedgeDoc` in your mind :smile: thanks! +*Note:* This guide was written before the renaming. Just replace `HackMD` with `HedgeDoc` in your mind 😃 thanks! 1. Sign in to your GitLab 2. Navigate to the application management page at `https://your.gitlab.domain/admin/applications` (admin permissions required) -- cgit v1.2.3 From 80d8cc79f6843bca557d882db32fae8c55ab425f Mon Sep 17 00:00:00 2001 From: David Mehren Date: Mon, 11 Jan 2021 12:00:33 +0100 Subject: Docs: Unify code block languages Use `yaml` for Dockerfiles, `shell` for environment variables and `json` for our config file. Signed-off-by: David Mehren --- docs/content/guides/auth/gitlab-self-hosted.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/content/guides/auth/gitlab-self-hosted.md') diff --git a/docs/content/guides/auth/gitlab-self-hosted.md b/docs/content/guides/auth/gitlab-self-hosted.md index 1205b487..d0d63ceb 100644 --- a/docs/content/guides/auth/gitlab-self-hosted.md +++ b/docs/content/guides/auth/gitlab-self-hosted.md @@ -15,7 +15,7 @@ 6. In the `docker-compose.yml` add the following environment variables to `app:` `environment:` -```Dockerfile +```yaml - CMD_DOMAIN=your.hedgedoc.domain - CMD_URL_ADDPORT=true - CMD_PROTOCOL_USESSL=true -- cgit v1.2.3 From 512fc2a914ec433616f98dbe5b921b9a6c11aadc Mon Sep 17 00:00:00 2001 From: David Mehren Date: Mon, 11 Jan 2021 12:05:31 +0100 Subject: GitLab Auth Guide: Fix indentation Signed-off-by: David Mehren --- docs/content/guides/auth/gitlab-self-hosted.md | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) (limited to 'docs/content/guides/auth/gitlab-self-hosted.md') diff --git a/docs/content/guides/auth/gitlab-self-hosted.md b/docs/content/guides/auth/gitlab-self-hosted.md index d0d63ceb..13a61a5b 100644 --- a/docs/content/guides/auth/gitlab-self-hosted.md +++ b/docs/content/guides/auth/gitlab-self-hosted.md @@ -6,25 +6,26 @@ 2. Navigate to the application management page at `https://your.gitlab.domain/admin/applications` (admin permissions required) 3. Click **New application** to create a new application and fill out the registration form: -![New GitLab application](../../images/auth/gitlab-new-application.png) + ![New GitLab application](../../images/auth/gitlab-new-application.png) 4. Click **Submit** -5. In the list of applications select **HackMD**. Leave that site open to copy the application ID and secret in the next step. +5. In the list of applications select **HackMD**. Leave that site open to copy the application ID and secret in the next + step. -![Application: HackMD](../../images/auth/gitlab-application-details.png) + ![Application: HackMD](../../images/auth/gitlab-application-details.png) 6. In the `docker-compose.yml` add the following environment variables to `app:` `environment:` -```yaml -- CMD_DOMAIN=your.hedgedoc.domain -- CMD_URL_ADDPORT=true -- CMD_PROTOCOL_USESSL=true -- CMD_GITLAB_BASEURL=https://your.gitlab.domain -- CMD_GITLAB_CLIENTID=23462a34example99XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX -- CMD_GITLAB_CLIENTSECRET=5532e9dexamplXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX -``` + ```yaml + - CMD_DOMAIN=your.hedgedoc.domain + - CMD_URL_ADDPORT=true + - CMD_PROTOCOL_USESSL=true + - CMD_GITLAB_BASEURL=https://your.gitlab.domain + - CMD_GITLAB_CLIENTID=23462a34example99XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + - CMD_GITLAB_CLIENTSECRET=5532e9dexamplXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + ``` 7. Run `docker-compose up -d` to apply your settings. 8. Sign in to your HedgeDoc using your GitLab ID: -![Sign in via GitLab](../../images/auth/gitlab-sign-in.png) + ![Sign in via GitLab](../../images/auth/gitlab-sign-in.png) -- cgit v1.2.3 From c8a7984fa430df3ce7d202d6653a3010585a0b2c Mon Sep 17 00:00:00 2001 From: David Mehren Date: Wed, 13 Jan 2021 19:36:45 +0100 Subject: Docs: Various formatting fixes Signed-off-by: David Mehren --- docs/content/guides/auth/gitlab-self-hosted.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/content/guides/auth/gitlab-self-hosted.md') diff --git a/docs/content/guides/auth/gitlab-self-hosted.md b/docs/content/guides/auth/gitlab-self-hosted.md index 13a61a5b..0ec5887a 100644 --- a/docs/content/guides/auth/gitlab-self-hosted.md +++ b/docs/content/guides/auth/gitlab-self-hosted.md @@ -1,6 +1,6 @@ # GitLab (self-hosted) -*Note:* This guide was written before the renaming. Just replace `HackMD` with `HedgeDoc` in your mind 😃 thanks! +**Note:** *This guide was written before the renaming. Just replace `HackMD` with `HedgeDoc` in your mind 😃 thanks!* 1. Sign in to your GitLab 2. Navigate to the application management page at `https://your.gitlab.domain/admin/applications` (admin permissions required) -- cgit v1.2.3