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 <sheogorath@shivering-isles.com>
This commit is contained in:
Sheogorath 2018-06-24 14:04:35 +02:00
parent a762928e97
commit 97a08e7954
No known key found for this signature in database
GPG Key ID: 1F05CC3635CDDFFD
7 changed files with 16 additions and 2 deletions

View File

@ -1,6 +1,8 @@
Authentication guide - GitHub 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 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 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: 3. Click on the **New OAuth App** button, to create a new OAuth App:

View File

@ -1,6 +1,8 @@
# GitLab (self-hosted) # 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 1. Sign in to your GitLab
2. Navigate to the application management page at `https://your.gitlab.domain/admin/applications` (admin permissions required) 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: 3. Click **New application** to create a new application and fill out the registration form:

View File

@ -1,6 +1,8 @@
Authentication guide - SAML (OneLogin) 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) 1. Sign-in or sign-up for an OneLogin account. (available free trial for 2 weeks)
2. Go to the administration page. 2. Go to the administration page.
3. Select the **APPS** menu and click on the **Add Apps**. 3. Select the **APPS** menu and click on the **Add Apps**.

View File

@ -1,6 +1,8 @@
Authentication guide - SAML 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. 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. * If your IdP accepts metadata XML of the service provider to ease configuraion, use this url to download metadata XML.

View File

@ -1,6 +1,8 @@
Authentication guide - Twitter 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 1. Sign-in or sign-up for a Twitter account
2. Go to the Twitter Application management page [here](https://apps.twitter.com/) 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: 3. Click on the **Create New App** button to create a new Twitter app:

View File

@ -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. 1. First of all you need to setup Minio itself.
Please refer to the [official Minio docs](https://docs.minio.io/) for an Please refer to the [official Minio docs](https://docs.minio.io/) for an

View File

@ -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. 1. Go to [AWS S3 console](https://console.aws.amazon.com/s3/home) and create a new bucket.