Add Google module documentation to toc. Fix Facebook and Twitter docu…

…mentation
OrchardCMS · Mar 25, 2019 · b794079 · b794079
1 parent b3c1163
commit b794079
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 26 deletions.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -87,3 +87,4 @@ nav:
         - Microsoft: OrchardCore.Modules/OrchardCore.Microsoft.Authentication/README.md
         - Facebook: OrchardCore.Modules/OrchardCore.Facebook/README.md
         - Twitter: OrchardCore.Modules/OrchardCore.Twitter/README.md
+        - Google: OrchardCore.Modules/OrchardCore.Google/README.md
diff --git a/src/OrchardCore.Modules/OrchardCore.Facebook/README.md b/src/OrchardCore.Modules/OrchardCore.Facebook/README.md
@@ -1,6 +1,7 @@
 # OrchardCore.Facebook
 
 ## Facebook Module
+
 `OrchardCore.Facebook` provides the following features 
 
 - Core Components
@@ -9,31 +10,31 @@
 Configuration can be set through the _Configuration -> Facebook_ settings menu in the admin dashboard.
 
 ## Core Components
+
 Registers the Facebook App with site.
 
 Available settings are:
 
-+ AppId: Facebook application id.
-+ AppSecret: The application secret.
+- AppId: Facebook application id.
+- AppSecret: The application secret.
 
 Both settings are available in the [facebook for developers application's](https://developers.facebook.com/apps) page, under Basic Settings.
 
 ## Facebook Login
-Authenticates users from Facebook. 
-If the site allows to register new users, a local user is created and the Facebook login is linked.
+
+Authenticates users from Facebook.  
+If the site allows to register new users, a local user is created and the Facebook login is linked.  
 If a local user with the same email is found, then the external login is linked to that account, after authenticating.
 
 The Facebook Login Product should be enabled in the [facebook for developers page](https://developers.facebook.com/apps) for web apps, 
 and a valid OAuth redirect URI must be set.
 
 Available settings are:
 
-+ CallbackPath: The request path within the application's base path where the user-agent will be returned. The middleware will process this request when it arrives.
+- CallbackPath: The request path within the application's base path where the user-agent will be returned. The middleware will process this request when it arrives.  
 If no value is provided, setup facebook app to use the default path /signin-facebook.
 
-*Users Registration*_
-+ If you want to enable new users to register to the site through their Facebook login, the `OrchardCore.Users.Registration` feature must be enabled and setup accordingly.
-+ An existing user can link his account to his Facebook login through the External Logins link from User menu
-
-
+*Users Registration*
 
+- If you want to enable new users to register to the site through their Facebook login, the `OrchardCore.Users.Registration` feature must be enabled and setup accordingly.
+- An existing user can link his account to his Facebook login through the External Logins link from User menu
diff --git a/src/OrchardCore.Modules/OrchardCore.Google/README.md b/src/OrchardCore.Modules/OrchardCore.Google/README.md
@@ -3,15 +3,17 @@
 This module adds Google features to OrchardCore.
 
 ## Google Analytics
+
 Enable Google Analytics Feature to integrate tracking on the front end site.
 
 Navigate to [Google Analytics](https://analytics.google.com/analytics/web) portal and select the Analytics account you want to use.
 
 Copy the Tracking ID from the Admin->Tracking Info->Tracking Code link.
 
-Το ψonfigure Orchard Core, go to _Google -> Google Analytics_ settings menu in the admin dashboard and enter the Tracking ID.
+Το configure Orchard Core, go to _Google -> Google Analytics_ settings menu in the admin dashboard and enter the Tracking ID.
 
 ## Google Authentication
+
 Enable Google Authentication to allow users to use their Google Account to login.
 
 Create a project in the [Google API Console](https://console.developers.google.com/projectselector/apis/library).
@@ -24,7 +26,7 @@ In the 'Where will you be calling the API from' question select the Web server (
 
 In the 'What data will you be accessing' question select 'User data'
 
-Now click the 'What credentials do I need?' button and set the ClientID.
+Now click the 'What credentials do I need?' button and set the ClientID.  
 You must also set the authorized redirect URI to point to your Orchard instance. The default url in OrchardCore is [tenant]/signin-google
 
 The next step is to parameterize the consent screen that will appear to the user.
@@ -37,12 +39,10 @@ Available settings are:
 
 + ClientID: The client_id field value in the downloaded json file.
 + ClientSecret: The client_secret field value in the downloaded json file.
-+ CallbackPath: The request path within the application's base path where the user-agent will be returned. The middleware will process this request when it arrives.
++ CallbackPath: The request path within the application's base path where the user-agent will be returned. The middleware will process this request when it arrives.  
 If no value is provided, setup Callback URL in Google API to use the default path /signin-google.
 
 *Users Registration*
-+ If you want to enable new users to register to the site through their Twitter account, the `OrchardCore.Users.Registration` feature must be enabled and setup accordingly.
-+ An existing user can link his account to his Twitter account through the External Logins link from User menu.
-
-
 
++ If you want to enable new users to register to the site through their Google account, the `OrchardCore.Users.Registration` feature must be enabled and setup accordingly.
++ An existing user can link his account to his Google account through the External Logins link from User menu.
diff --git a/src/OrchardCore.Modules/OrchardCore.Twitter/README.md b/src/OrchardCore.Modules/OrchardCore.Twitter/README.md
@@ -1,25 +1,24 @@
-# Twitter (OrchardCore.Twiter)
+# Twitter (OrchardCore.Twitter)
 
 This module adds Twitter for Websites features to OrchardCore.
 
 ## Sign in with Twitter
+
 Authenticates users with their Twitter Account. 
 
-Create an app in the [Twitter Developer Platform](https://developer.twitter.com) and enable Sign in with Twitter.
+Create an app in the [Twitter Developer Platform](https://developer.twitter.com) and enable Sign in with Twitter.  
 In the app details, you must configure the Callback URL. The default url in OrchardCore is [tenant]/signin-twitter.
 
 Configuration can be set through the _Twitter -> Sign in with Twitter_ settings menu in the admin dashboard.
 
 Available settings are:
 
-+ ConsumerKey: API key found in the keys and tokens tab of your twitter app.
-+ ConsumerSecret: The API secret key of your twitter app.
-+ CallbackPath: The request path within the application's base path where the user-agent will be returned. The middleware will process this request when it arrives.
+- ConsumerKey: API key found in the keys and tokens tab of your twitter app.
+- ConsumerSecret: The API secret key of your twitter app.
+- CallbackPath: The request path within the application's base path where the user-agent will be returned. The middleware will process this request when it arrives.  
 If no value is provided, setup Callback URL in Twitter app to use the default path /signin-twitter.
 
 *Users Registration*
-+ If you want to enable new users to register to the site through their Twitter account, the `OrchardCore.Users.Registration` feature must be enabled and setup accordingly.
-+ An existing user can link his account to his Twitter account through the External Logins link from User menu.
-
-
 
+- If you want to enable new users to register to the site through their Twitter account, the `OrchardCore.Users.Registration` feature must be enabled and setup accordingly.
+- An existing user can link his account to his Twitter account through the External Logins link from User menu.