From edf301cfa320cce48eaf055a57f416bc1aa6ee1e Mon Sep 17 00:00:00 2001 From: Claudius Date: Sun, 31 Mar 2019 16:02:05 +0200 Subject: splitting README.md into files in /docs for better readability Signed-off-by: Claudius --- docs/guides/auth/github.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'docs/guides/auth/github.md') diff --git a/docs/guides/auth/github.md b/docs/guides/auth/github.md index d6a1095e..482bca31 100644 --- a/docs/guides/auth/github.md +++ b/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 /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: -- cgit v1.2.3 From 54edec89000aec94cae325be3d5c85442ac21adf Mon Sep 17 00:00:00 2001 From: Claudius Date: Sun, 31 Mar 2019 20:10:32 +0200 Subject: striving for consistency across various docs Signed-off-by: Claudius --- docs/guides/auth/github.md | 31 ++++++++++++++----------------- 1 file changed, 14 insertions(+), 17 deletions(-) (limited to 'docs/guides/auth/github.md') diff --git a/docs/guides/auth/github.md b/docs/guides/auth/github.md index 482bca31..d16b486f 100644 --- a/docs/guides/auth/github.md +++ b/docs/guides/auth/github.md @@ -1,27 +1,24 @@ Authentication guide - GitHub === -***Note:** This guide was written before the renaming. Just replace `HackMD` with `CodiMD` in your mind :smile: thanks!* +**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: +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) -4. Fill out the new OAuth application registration form, and click **Register Application** + **Note:** *The callback URL is /auth/github/callback* -![register-oauth-application-form](../../images/auth/register-oauth-application-form.png) - -*Note: The callback URL is /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) +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) 6. Add the Client ID and Client Secret to your config.json file or pass them as environment variables - * config.json: - ````javascript + * `config.json`: + ```js { "production": { "github": { @@ -30,9 +27,9 @@ Authentication guide - GitHub } } } - ```` + ``` * environment variables: - ```` - HMD_GITHUB_CLIENTID=3747d30eaccXXXXXXXXX - HMD_GITHUB_CLIENTSECRET=2a8e682948eee0c580XXXXXXXXXXXXXXXXXXXXXX + ```sh + CMD_GITHUB_CLIENTID=3747d30eaccXXXXXXXXX + CMD_GITHUB_CLIENTSECRET=2a8e682948eee0c580XXXXXXXXXXXXXXXXXXXXXX ```` -- cgit v1.2.3