From 97a08e7954af01719bb2519e863fdf5990d4d56f Mon Sep 17 00:00:00 2001 From: Sheogorath Date: Sun, 24 Jun 2018 14:04:35 +0200 Subject: [PATCH] Add note about renaming to docs It's way easier to add a note to the guides than to redo all the images, etc. We have more important things to spend our time on, but if someone wants to redo them, you are very welcome! Signed-off-by: Sheogorath --- docs/guides/auth/github.md | 2 ++ docs/guides/auth/gitlab-self-hosted.md | 2 ++ docs/guides/auth/saml-onelogin.md | 2 ++ docs/guides/auth/saml.md | 2 ++ docs/guides/auth/twitter.md | 2 ++ docs/guides/minio-image-upload.md | 4 +++- docs/guides/s3-image-upload.md | 4 +++- 7 files changed, 16 insertions(+), 2 deletions(-) diff --git a/docs/guides/auth/github.md b/docs/guides/auth/github.md index 62910cb..d6a1095 100644 --- a/docs/guides/auth/github.md +++ b/docs/guides/auth/github.md @@ -1,6 +1,8 @@ Authentication guide - GitHub === +***Note:** This guide was written before the renaming. Just replace `HackMD` with `CodiMD` in your mind :smile: thanks!* + 1. Sign-in or sign-up for a GitHub account 2. Navigate to developer settings in your GitHub account [here](https://github.com/settings/developers) and select the "OAuth Apps" tab 3. Click on the **New OAuth App** button, to create a new OAuth App: diff --git a/docs/guides/auth/gitlab-self-hosted.md b/docs/guides/auth/gitlab-self-hosted.md index 361ee95..89bc996 100644 --- a/docs/guides/auth/gitlab-self-hosted.md +++ b/docs/guides/auth/gitlab-self-hosted.md @@ -1,6 +1,8 @@ # GitLab (self-hosted) === +***Note:** This guide was written before the renaming. Just replace `HackMD` with `CodiMD` in your mind :smile: thanks!* + 1. Sign in to your GitLab 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: diff --git a/docs/guides/auth/saml-onelogin.md b/docs/guides/auth/saml-onelogin.md index 245876c..02a5ffa 100644 --- a/docs/guides/auth/saml-onelogin.md +++ b/docs/guides/auth/saml-onelogin.md @@ -1,6 +1,8 @@ Authentication guide - SAML (OneLogin) === +***Note:** This guide was written before the renaming. Just replace `HackMD` with `CodiMD` in your mind :smile: thanks!* + 1. Sign-in or sign-up for an OneLogin account. (available free trial for 2 weeks) 2. Go to the administration page. 3. Select the **APPS** menu and click on the **Add Apps**. diff --git a/docs/guides/auth/saml.md b/docs/guides/auth/saml.md index 9a51667..97ac9d3 100644 --- a/docs/guides/auth/saml.md +++ b/docs/guides/auth/saml.md @@ -1,6 +1,8 @@ Authentication guide - SAML === +***Note:** This guide was written before the renaming. Just replace `HackMD` with `CodiMD` in your mind :smile: thanks!* + The basic procedure is the same as the case of OneLogin which is mentioned in [OneLogin-Guide](./saml-onelogin.md). If you want to match your IdP, you can use more configurations as below. * If your IdP accepts metadata XML of the service provider to ease configuraion, use this url to download metadata XML. diff --git a/docs/guides/auth/twitter.md b/docs/guides/auth/twitter.md index 02309ca..1b96288 100644 --- a/docs/guides/auth/twitter.md +++ b/docs/guides/auth/twitter.md @@ -1,6 +1,8 @@ Authentication guide - Twitter === +***Note:** This guide was written before the renaming. Just replace `HackMD` with `CodiMD` in your mind :smile: thanks!* + 1. Sign-in or sign-up for a Twitter account 2. Go to the Twitter Application management page [here](https://apps.twitter.com/) 3. Click on the **Create New App** button to create a new Twitter app: diff --git a/docs/guides/minio-image-upload.md b/docs/guides/minio-image-upload.md index c2ba25b..7f5796c 100644 --- a/docs/guides/minio-image-upload.md +++ b/docs/guides/minio-image-upload.md @@ -1,6 +1,8 @@ -Minio Guide for HackMD +Minio Guide for CodiMD === +***Note:** This guide was written before the renaming. Just replace `HackMD` with `CodiMD` in your mind :smile: thanks!* + 1. First of all you need to setup Minio itself. Please refer to the [official Minio docs](https://docs.minio.io/) for an diff --git a/docs/guides/s3-image-upload.md b/docs/guides/s3-image-upload.md index ff9598a..dc5e420 100644 --- a/docs/guides/s3-image-upload.md +++ b/docs/guides/s3-image-upload.md @@ -1,4 +1,6 @@ -# Guide - Setup HackMD S3 image upload +# Guide - Setup CodiMD S3 image upload + +***Note:** This guide was written before the renaming. Just replace `HackMD` with `CodiMD` in your mind :smile: thanks!* 1. Go to [AWS S3 console](https://console.aws.amazon.com/s3/home) and create a new bucket.