splitting README.md into files in /docs for better readability

Signed-off-by: Claudius <opensource@amenthes.de>

docs/guides/auth/github.md

@@ -7,17 +7,17 @@ Authentication guide - GitHub
 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:
 
-![create-oauth-app](../images/auth/create-oauth-app.png)
+![create-oauth-app](../../images/auth/create-oauth-app.png)
 
 4. Fill out the new OAuth application registration form, and click **Register Application**
 
-![register-oauth-application-form](../images/auth/register-oauth-application-form.png)
+![register-oauth-application-form](../../images/auth/register-oauth-application-form.png)
 
 *Note: The callback URL is <your-hackmd-url>/auth/github/callback*
 
 5. After successfully registering the application, you'll receive the Client ID and Client Secret for the application
 
-![application-page](../images/auth/application-page.png)
+![application-page](../../images/auth/application-page.png)
 
 6. Add the Client ID and Client Secret to your config.json file or pass them as environment variables
     * config.json:

docs/guides/auth/gitlab-self-hosted.md

@@ -7,12 +7,12 @@
 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.
 
-![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:`
@@ -29,4 +29,4 @@
 7. Run `docker-compose up -d` to apply your settings.
 8. Sign in to your HackMD using your GitLab ID:
 
-![Sign in via GitLab](../images/auth/gitlab-sign-in.png)
+![Sign in via GitLab](../../images/auth/gitlab-sign-in.png)

docs/guides/auth/mattermost-self-hosted.md

@@ -8,22 +8,22 @@ This guide uses the generic OAuth2 module for compatibility with Mattermost vers
 1. Sign-in with an administrator account to your Mattermost instance
 2. Make sure **OAuth 2.0 Service Provider** is enabled in the Main Menu (menu button next to your username in the top left corner) --> System Console --> Custom Integrations menu, which you can find at `https://your.mattermost.domain/admin_console/integrations/custom`
 
-![mattermost-enable-oauth2](../images/auth/mattermost-enable-oauth2.png)
+![mattermost-enable-oauth2](../../images/auth/mattermost-enable-oauth2.png)
 
 3. Navigate to the OAuth integration settings through Main Menu --> Integrations --> OAuth 2.0 Applications, at `https://your.mattermost.domain/yourteam/integrations/oauth2-apps`
 4. Click on the **Add OAuth 2.0 Application** button to add a new OAuth application
 
-![mattermost-oauth-app-add](../images/auth/mattermost-oauth-app-add.png)
+![mattermost-oauth-app-add](../../images/auth/mattermost-oauth-app-add.png)
 
 5. Fill out the form and click **Save**
 
-![mattermost-oauth-app-form](../images/auth/mattermost-oauth-app-form.png)
+![mattermost-oauth-app-form](../../images/auth/mattermost-oauth-app-form.png)
 
 *Note: The callback URL is \<your-codimd-url\>/auth/oauth2/callback*
 
 6. After saving the application, you'll receive the Client ID and Client Secret
 
-![mattermost-oauth-app-done](../images/auth/mattermost-oauth-app-done.png)
+![mattermost-oauth-app-done](../../images/auth/mattermost-oauth-app-done.png)
 
 7. Add the Client ID and Client Secret to your config.json file or pass them as environment variables
     * config.json:

docs/guides/auth/nextcloud.md

@@ -10,14 +10,14 @@ This guide uses the generic OAuth2 module for compatibility with Nextcloud 13 an
 2. Navigate to the OAuth integration settings: Profile Icon (top right) --> Settings
    Then choose Security Settings from the *Administration* part of the list - Don't confuse this with Personal Security Settings, where you would change your personal password!
    At the top there's OAuth 2.0-Clients.
-   ![Where to find OAuth2 in Nextcloud](../images/auth/nextcloud-oauth2-1-settings.png)
+   ![Where to find OAuth2 in Nextcloud](../../images/auth/nextcloud-oauth2-1-settings.png)
 
 3. Add your CodiMD instance by giving it a *name* (perhaps CodiMD, but could be anything) and a *Redirection-URI*. The Redirection-URI will be `\<your-codimd-url\>/auth/oauth2/callback`. Click <kbd>Add</kbd>.
-   ![Adding a client to Nextcloud](../images/auth/nextcloud-oauth2-2-client-add.png)
+   ![Adding a client to Nextcloud](../../images/auth/nextcloud-oauth2-2-client-add.png)
 
 
 4. You'll now see a line containing a *client identifier* and a *Secret*.
-   ![Successfully added OAuth2-client](../images/auth/nextcloud-oauth2-3-clientid-secret.png)
+   ![Successfully added OAuth2-client](../../images/auth/nextcloud-oauth2-3-clientid-secret.png)
 
 5. That's it for Nextcloud, the rest is configured in your CodiMD `config.json` or via the `CMD_` environment variables!
 

docs/guides/auth/oauth.md

@@ -0,0 +1,12 @@
+# OAuth general information
+
+| service | callback URL (after the server URL) |
+| ------- | --------- |
+| facebook | `/auth/facebook/callback` |
+| twitter | `/auth/twitter/callback` |
+| github | `/auth/github/callback` |
+| gitlab | `/auth/gitlab/callback` |
+| mattermost | `/auth/mattermost/callback` |
+| dropbox | `/auth/dropbox/callback` |
+| google | `/auth/google/callback` |
+| saml | `/auth/saml/callback` |

docs/guides/auth/saml-onelogin.md

@@ -7,15 +7,15 @@ Authentication guide - SAML (OneLogin)
 2. Go to the administration page.
 3. Select the **APPS** menu and click on the **Add Apps**.
 
-![onelogin-add-app](../images/auth/onelogin-add-app.png)
+![onelogin-add-app](../../images/auth/onelogin-add-app.png)
 
 4. Find "SAML Test Connector (SP)" for template of settings and select it.
 
-![onelogin-select-template](../images/auth/onelogin-select-template.png)
+![onelogin-select-template](../../images/auth/onelogin-select-template.png)
 
 5. Edit display name and icons for OneLogin dashboard as you want, and click **SAVE**.
 
-![onelogin-edit-app-name](../images/auth/onelogin-edit-app-name.png)
+![onelogin-edit-app-name](../../images/auth/onelogin-edit-app-name.png)
 
 6. After that other tabs will appear, click the **Configuration**, and fill out the below items, and click **SAVE**.
     * RelayState: The base URL of your hackmd, which is issuer. (last slash is not needed)
@@ -23,13 +23,13 @@ Authentication guide - SAML (OneLogin)
     * ACS (Consumer) URL: same as above.
     * Login URL: login URL(SAML requester) of your hackmd. (serverurl + /auth/saml)
 
-![onelogin-edit-sp-metadata](../images/auth/onelogin-edit-sp-metadata.png)
+![onelogin-edit-sp-metadata](../../images/auth/onelogin-edit-sp-metadata.png)
 
 7. The registration is completed. Next, click **SSO** and copy or download the items below.
     * X.509 Certificate: Click **View Details** and **DOWNLOAD** or copy the content of certificate ....(A)
     * SAML 2.0 Endpoint (HTTP): Copy the URL ....(B)
 
-![onelogin-copy-idp-metadata](../images/auth/onelogin-copy-idp-metadata.png)
+![onelogin-copy-idp-metadata](../../images/auth/onelogin-copy-idp-metadata.png)
 
 8. In your hackmd server, create IdP certificate file from (A)
 9. Add the IdP URL (B) and the Idp certificate file path to your config.json file or pass them as environment variables.
@@ -51,4 +51,4 @@ Authentication guide - SAML (OneLogin)
       ````
 10. Try sign-in with SAML from your hackmd sign-in button or OneLogin dashboard (like the screenshot below).
 
-![onelogin-use-dashboard](../images/auth/onelogin-use-dashboard.png)
+![onelogin-use-dashboard](../../images/auth/onelogin-use-dashboard.png)

docs/guides/auth/twitter.md

@@ -7,11 +7,11 @@ Authentication guide - Twitter
 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:
 
-![create-twitter-app](../images/auth/create-twitter-app.png)
+![create-twitter-app](../../images/auth/create-twitter-app.png)
 
 4. Fill out the create application form, check the developer agreement box, and click **Create Your Twitter Application**
 
-![register-twitter-application](../images/auth/register-twitter-application.png)
+![register-twitter-application](../../images/auth/register-twitter-application.png)
 
 *Note: you may have to register your phone number with Twitter to create a Twitter application*
 
@@ -19,11 +19,11 @@ To do this Click your profile icon --> Settings and privacy --> Mobile  --> Sele
 
 5. After you receive confirmation that the Twitter application was created, click **Keys and Access Tokens**
 
-![twitter-app-confirmation](../images/auth/twitter-app-confirmation.png)
+![twitter-app-confirmation](../../images/auth/twitter-app-confirmation.png)
 
 6. Obtain your Twitter Consumer Key and Consumer Secret
 
-![twitter-app-keys](../images/auth/twitter-app-keys.png)
+![twitter-app-keys](../../images/auth/twitter-app-keys.png)
 
 7.  Add your Consumer Key and Consumer Secret to your config.json file or pass them as environment variables:
     * config.json:

docs/guides/migrations-and-breaking-changes.md

@@ -0,0 +1,58 @@
+# Migrations and Notable Changes
+
+## Migrating to 1.3.2
+
+This is not a breaking change, but to stay up to date with the community
+repository, you may need to update a few urls. This is not a breaking change.
+
+See more at [issue #10](https://github.com/codimd/server/issues/10)
+
+**Native setup using git:**
+
+Change the upstream remote using `git remote set-url origin https://github.com/codimd/server.git`.
+
+**Docker:**
+
+When you use our [container repository](https://github.com/codimd/container) 
+(which was previously `codimd-container`) all you can simply run `git pull` and
+your `docker-compose.yml` will be updated.
+
+When you setup things yourself, make sure you use the new image:
+[`quay.io/codimd/server`](https://quay.io/repository/codimd/server?tab=tags).
+
+**Heroku:**
+
+All you need to do is [disconnect GitHub](https://devcenter.heroku.com/articles/github-integration#disconnecting-from-github)
+and [reconnect it](https://devcenter.heroku.com/articles/github-integration#enabling-github-integration)
+with this new repository.
+
+Or you can use our Heroku button and redeploy your instance and link the old
+database again.
+
+## Migrating to 1.1.0
+
+We deprecated the older lower case config style and moved on to camel case style. Please have a look at the current `config.json.example` and check the warnings on startup.
+
+*Notice: This is not a breaking change right now but will be in the future*
+
+## Migrating to 0.5.0
+
+[**migration-to-0.5.0**](https://github.com/hackmdio/migration-to-0.5.0)
+
+We don't use LZString to compress socket.io data and DB data after version 0.5.0.
+Please run the migration tool if you're upgrading from the old version.
+
+## Migrating to 0.4.0
+
+[**migration-to-0.4.0**](https://github.com/hackmdio/migration-to-0.4.0)
+
+We've dropped MongoDB after version 0.4.0.
+So here is the migration tool for you to transfer the old DB data to the new DB.
+This tool is also used for official service.
+
+## Operational Transformation in 0.3.2
+
+From 0.3.2, we started supporting operational transformation.
+It makes concurrent editing safe and will not break up other users' operations.
+Additionally, now can show other clients' selections.
+See more at [http://operational-transformation.github.io/](http://operational-transformation.github.io/)

docs/guides/minio-image-upload.md

@@ -22,22 +22,22 @@ Minio Guide for CodiMD
    docker logs test-minio
    ```
 
-   ![docker logs](images/minio-image-upload/docker-logs.png)
+   ![docker logs](../images/minio-image-upload/docker-logs.png)
 
 3. Open http://localhost:9000 and login with the shown credentials.
 
-   ![minio default view](images/minio-image-upload/default-view.png)
+   ![minio default view](../images/minio-image-upload/default-view.png)
 
 4. Create a bucket for HackMD
 
-   ![minio create bucket](images/minio-image-upload/create-bucket.png)
+   ![minio create bucket](../images/minio-image-upload/create-bucket.png)
 
 5. Add a policy for the prefix `uploads` and make it read-only.
 
-   ![minio edit policy](images/minio-image-upload/open-edit-policy.png)
+   ![minio edit policy](../images/minio-image-upload/open-edit-policy.png)
    *Open policy editor*
 
-   ![minio policy adding](images/minio-image-upload/create-policy.png)
+   ![minio policy adding](../images/minio-image-upload/create-policy.png)
    *Add policy for uploads*
 
 6. Set credentials and configs for Minio in HackMD's `config.json`

docs/guides/s3-image-upload.md

@@ -4,15 +4,15 @@
 
 1. Go to [AWS S3 console](https://console.aws.amazon.com/s3/home) and create a new bucket.
 
-    ![create-bucket](images/s3-image-upload/create-bucket.png)
+    ![create-bucket](../images/s3-image-upload/create-bucket.png)
 
 2. Click on bucket, select **Properties**  on the side panel, and find **Permission** section. Click **Edit bucket policy**.
 
-    ![bucket-property](images/s3-image-upload/bucket-property.png)
+    ![bucket-property](../images/s3-image-upload/bucket-property.png)
 
 3. Enter the following policy, replace `bucket_name` with your bucket name:
 
-    ![bucket-policy-editor](images/s3-image-upload/bucket-policy-editor.png)
+    ![bucket-policy-editor](../images/s3-image-upload/bucket-policy-editor.png)
 
     ```json
     {
@@ -32,15 +32,15 @@
 
 5. Enter user page, select **Permission** tab, look at **Inline Policies** section, and click **Create User Policy**
 
-    ![iam-user](images/s3-image-upload/iam-user.png)
+    ![iam-user](../images/s3-image-upload/iam-user.png)
 
 6. Select **Custom Policy**
 
-    ![custom-policy](images/s3-image-upload/custom-policy.png)
+    ![custom-policy](../images/s3-image-upload/custom-policy.png)
 
 7. Enter the following policy, replace `bucket_name` with your bucket name:
 
-    ![review-policy](images/s3-image-upload/review-policy.png)
+    ![review-policy](../images/s3-image-upload/review-policy.png)
 
     ```json
     {