Updated documentation

factly · Aug 25, 2021 · cc84a7b · cc84a7b
1 parent 9365951
commit cc84a7b
Show file tree

Hide file tree

Showing 20 changed files with 372 additions and 74 deletions.
diff --git a/website/docs/core-concepts/categories.md b/website/docs/core-concepts/categories.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 3
+sidebar_position: 12
 ---
 
 # Categories
@@ -16,15 +16,17 @@ Category can be added from the Categories menu item by clicking on the New Categ
 - Description: Describes what the category is for.
 
 ### SEO Metadata
+
 Apart from the basic information, extra data can be added such as [SEO metadata](/docs/features/search-engine-optimisation). SEO metadata includes title, description, and canonical URL. It can be added by clicking on the Add MetaData button.
 
 ### Metafields
+
 There is also a provision to add more information about the category if the field is not included in the form. The user can use the [Metafields](/docs/features/extend-features) section by clicking on the Meta Fields section to feed in extra data as a JSON object.
 
 Customizing the header and footer specific to a category can be done by adding code in the Code Injection section by clicking on the Code Injection section.
 
 All the Categories will be available under the Categories menu.
-Search and sort options are available to simplify the search for a Category. Categories can be deleted by clicking on the Delete button. To edit a Category click on the name of the category in the list.
+[Search](/docs/features/search-and-filtering) and sort options are available to simplify the search for a Category. Categories can be deleted by clicking on the Delete button. To edit a Category click on the name of the category in the list.
 
 ### Policies
 

diff --git a/website/docs/core-concepts/claimants.md b/website/docs/core-concepts/claimants.md
@@ -14,15 +14,17 @@ The user can add a claimant from the Claimants menu item by clicking on the New
 - Description - Information about the claimant
 
 ### SEO Metadata
+
 Apart from the basic information, extra data can be added such as [SEO metadata](/docs/features/search-engine-optimisation). SEO metadata includes title, description, and canonical URL. It can be added by clicking on the Add MetaData button.
 
 ### Metafields
+
 There is also a provision to add more information about the claimant if the field is not included in the form. The user can use the [Metafields](/docs/features/extend-features) section by clicking on the Meta Fields section to feed in extra data as a JSON object.
 
 Customizing the header and footer specific to a claimant can be done by adding code in the Code Injection section by clicking on the Code Injection section.
 
 All the Claimants will be available under the Claimants menu.
-Search and sort options are available to simplify the search for a Claimant. Claimants can be deleted by clicking on the Delete button. To edit a Claimant click on the name of the claimant in the list.
+[Search](/docs/features/search-and-filtering) and sort options are available to simplify the search for a Claimant. Claimants can be deleted by clicking on the Delete button. To edit a Claimant click on the name of the claimant in the list.
 
 ### Policies
 

diff --git a/website/docs/core-concepts/claims.md b/website/docs/core-concepts/claims.md
@@ -21,15 +21,17 @@ Claim Settings:
   By clicking on the Add Review Sources button, new fields are added to add information about the review sources. Url and description can be provided for each review source.
 
 ### SEO Metadata
+
 Apart from the basic information, extra data can be added such as [SEO metadata](/docs/features/search-engine-optimisation). SEO metadata includes title, description, and canonical URL. It can be added by clicking on the Add MetaData button.
 
 ### Metafields
+
 There is also a provision to add more information about the claim if the field is not included in the form. The user can use the [Metafields](/docs/features/extend-features) section by clicking on the Meta Fields section to feed in extra data as a JSON object.
 
 Customizing the header and footer specific to a claim can be done by adding code in the Code Injection section by clicking on the Code Injection section.
 
 All the Claims will be available under the Claims menu.
-Filter and sort options are available to simplify the search for Claims. Available filters are Ratings and Claimants. Claims can be deleted by clicking on the Delete button. To edit a Claim click on the name of the claim in the list.
+[Filter](/docs/features/search-and-filtering) and sort options are available to simplify the search for Claims. Available filters are Ratings and Claimants. Claims can be deleted by clicking on the Delete button. To edit a Claim click on the name of the claim in the list.
 
 ### Policies
 

diff --git a/website/docs/core-concepts/events.md b/website/docs/core-concepts/events.md
@@ -4,61 +4,62 @@ sidebar_position: 9
 
 # Events
 
-Events define when to trigger a notification for a webhook.
+Events define when to trigger a notification for a webhook. For example, whenever a post is published user receives a notification on Slack or Google Chat.
 
 #### Webhooks
-Webhooks are used to notify the users when defined events have occurred. These allow Dega to send POST requests to user-configured URLs to send them a notification about it. The request contains a triggered event and the result could be a notification on the set URL. 
+
+Webhooks are used to notify the users when defined events have occurred. These allow Dega to send POST requests to user-configured URLs to send them a notification about it. The request contains a triggered event and the result could be a notification on the set URL.
 To use webhooks, setting up [Hukz](https://github.com/factly/hukz) is required. Hukz is a simple & lightweight service implemented in GO to add webhooks to your application. This service is intended to fire webhooks on different events that are registered.
 Webhook can be added from the Webhook menu item by clicking on New Webhook. Webhooks can be added only by admins of the organization.
 
 The user can add default events supported by Dega by clicking on Create default events. Events can be added only by the super organization. While creating webhook supported events are assigned to a webhook.
 
-All the Events will be available under the Events menu. 
+All the Events will be available under the Events menu.
 Events can be deleted by clicking on the Delete button. To edit an event click on the name of the event in the list.
 
 The events supported in Dega are listed below:
 
-|  Events          | Description                                        |
-|------------------|----------------------------------------------------|
-| Create Category  | Triggered when a category is added                 |
-| Update Category  | Triggered when a category is edited                |
-| Delete Category  | Triggered when a category is deleted               |
-| Create Format    | Triggered when a format is added                   |
-| Update Format    | Triggered when a format is edited                  |
-| Delete Format    | Triggered when a format is deleted                 |
-| Create Media     | Triggered when a media  is added                   |
-| Update Media     | Triggered when a media is edited                   |
-| Delete Media     | Triggered when a media is deleted                  |
-| Create Menu      | Triggered when a menu is added                     |
-| Update Menu      | Triggered when a menu is edited                    |
-| Delete Menu      | Triggered when a menu is deleted                   |
-| Create Post      | Triggered when a post is added                     |
-| Update Post      | Triggered when a post is edited                    |
-| Delete Post      | Triggered when a post is deleted                   |
-| Create Template  | Triggered when a template is created               |
-| Publish Post     | Triggered when a post is published                 |
-| Unpublish Post   | Triggered when a post is unpublished               |
-| Ready Post       | Triggered when a post is saved as Ready to Publish |
-| Create Space     | Triggered when a space is added                    |
-| Update Space     | Triggered when a space is edited                   |
-| Delete Space     | Triggered when a space is deleted                  |
-| Create Tag       | Triggered when a tag is added                      |
-| Update Tag       | Triggered when a tag is edited                     |
-| Delete Tag       | Triggered when a tag is deleted                    |
-| Create Claim     | Triggered when a claim is added                    |
-| Update Claim     | Triggered when a claim is edited                   |
-| Delete Claim     | Triggered when a claim is deleted                  |
-| Create Claimant  | Triggered when a claimant is added                 |
-| Update Claimant  | Triggered when a claimant is edited                |  
-| Delete Claimant  | Triggered when a claimant is deleted               |
-| Create Rating    | Triggered when a rating is added                   |
-| Update Rating    | Triggered when a rating is edited                  |
-| Delete Rating    | Triggered when a rating is deleted                 |
-| Create Podcast   | Triggered when a podcast is added                  |
-| Update Podcast   | Triggered when a podcast is edited                 |
-| Delete Podcast   | Triggered when a podcast is deleted                |
-| Create Episode   | Triggered when a episode is added                  |
-| Update Episode   | Triggered when a episode is edited                 |
-| Delete Episode   | Triggered when a episode is deleted                |
-| Create Policy    | Triggered when a policy is added                   |
-| Update Policy    | Triggered when a policy is updated                 |
+| Events          | Description                                        |
+| --------------- | -------------------------------------------------- |
+| Create Category | Triggered when a category is added                 |
+| Update Category | Triggered when a category is edited                |
+| Delete Category | Triggered when a category is deleted               |
+| Create Format   | Triggered when a format is added                   |
+| Update Format   | Triggered when a format is edited                  |
+| Delete Format   | Triggered when a format is deleted                 |
+| Create Media    | Triggered when a media is added                    |
+| Update Media    | Triggered when a media is edited                   |
+| Delete Media    | Triggered when a media is deleted                  |
+| Create Menu     | Triggered when a menu is added                     |
+| Update Menu     | Triggered when a menu is edited                    |
+| Delete Menu     | Triggered when a menu is deleted                   |
+| Create Post     | Triggered when a post is added                     |
+| Update Post     | Triggered when a post is edited                    |
+| Delete Post     | Triggered when a post is deleted                   |
+| Create Template | Triggered when a template is created               |
+| Publish Post    | Triggered when a post is published                 |
+| Unpublish Post  | Triggered when a post is unpublished               |
+| Ready Post      | Triggered when a post is saved as Ready to Publish |
+| Create Space    | Triggered when a space is added                    |
+| Update Space    | Triggered when a space is edited                   |
+| Delete Space    | Triggered when a space is deleted                  |
+| Create Tag      | Triggered when a tag is added                      |
+| Update Tag      | Triggered when a tag is edited                     |
+| Delete Tag      | Triggered when a tag is deleted                    |
+| Create Claim    | Triggered when a claim is added                    |
+| Update Claim    | Triggered when a claim is edited                   |
+| Delete Claim    | Triggered when a claim is deleted                  |
+| Create Claimant | Triggered when a claimant is added                 |
+| Update Claimant | Triggered when a claimant is edited                |
+| Delete Claimant | Triggered when a claimant is deleted               |
+| Create Rating   | Triggered when a rating is added                   |
+| Update Rating   | Triggered when a rating is edited                  |
+| Delete Rating   | Triggered when a rating is deleted                 |
+| Create Podcast  | Triggered when a podcast is added                  |
+| Update Podcast  | Triggered when a podcast is edited                 |
+| Delete Podcast  | Triggered when a podcast is deleted                |
+| Create Episode  | Triggered when a episode is added                  |
+| Update Episode  | Triggered when a episode is edited                 |
+| Delete Episode  | Triggered when a episode is deleted                |
+| Create Policy   | Triggered when a policy is added                   |
+| Update Policy   | Triggered when a policy is updated                 |
diff --git a/website/docs/core-concepts/fact-checks.md b/website/docs/core-concepts/fact-checks.md
@@ -8,7 +8,7 @@ Fact-checks are posts of format: fact-check. Fact-checks have all the features a
 Fact-Check can include claims and images.
 New fact-check can be created from the Fact-Checks menu by clicking on the New Fact-Check button on the right side.
 
-The user can start writing fact-check using an editor which is a rich text editor. It makes embedding images, links, or any related content very easy.
+The user can start writing fact-check using an [editor](/docs/features/powerful-editor) which is a rich text editor. It makes embedding images, links, or any related content very easy.
 
 The user can directly publish or can save it as a draft. The user can also mark the post as ready to Publish.
 
@@ -19,7 +19,7 @@ Each post created has status from any of the following.
 - Ready to Publish
 
 To save as draft click on the Save button on the right and to save as Ready to Publish; before clicking on the Save button make sure Ready to Publish is checked.
-To publish the Fact-Check click on the Publish button. Only the user who is either admin or has permission to publish can publish the fact-check.
+To publish the Fact-Check click on the Publish button. Only the user who is either an admin or has the permission to publish can publish the fact-check.
 
 Once the post is created, templates can be created from the post which can be used for future fact-checks. Templates are created by clicking on the Create Template button.
 New Fact-checks can be created from templates by clicking on any of the templates available from the Templates section which is at the top of the Fact-check page.
@@ -37,16 +37,24 @@ The user can add information about the fact-check by clicking on the Settings bu
 - Published Date - The date of publishing for the fact-check. If not entered automatically takes the current date when clicked on the Publish button.
 
 ### SEO Metadata
+
 Apart from the basic information, extra data can be added such as [SEO metadata](/docs/features/search-engine-optimisation). SEO metadata includes title, description, and canonical URL. It can be added by clicking on the Add MetaData button.
 
 ### Metafields
+
 There is also a provision to add more information about the fact-check if the field is not included in the form. The user can use the [Metafields](/docs/features/extend-features) section by clicking on the Add Meta Fields button to feed in extra data as a JSON object.
 
+### Code Injection
+
 Customizing the header and footer specific to a post can be done by adding code in the Code Injection section by clicking on the Code Injection button.
 
+### Schema
+
+Schema is generated automatically in the backend. This will be available in the Schema Section.
+
 All the fact-checks will be available under the Fact-Check menu. The list shows fact-checks with their categories, tags, and status. Three options are available: Edit, Quick Edit, and Delete.
 
-To simplify the search for a fact-check, filter and sort options are available.
+To simplify the [search](/docs/features/search-and-filtering) for a fact-check, filter and sort options are available.
 Click on the More filters button right next to the New Fact-Check button to see the available filters.
 Available filters are Tags, Categories, Status, Authors.
 

diff --git a/website/docs/core-concepts/formats.md b/website/docs/core-concepts/formats.md
@@ -18,10 +18,12 @@ Fact-Check and Article formats are mandatory formats for Dega.
 - Featured Image - Image for the format
 - Description: Describes what the format is.
 
-### SEO Metadata 
+### SEO Metadata
+
 Apart from the basic information, extra data can be added such as [SEO metadata](/docs/features/search-engine-optimisation). SEO metadata includes title, description, and canonical URL. It can be added by clicking on the Add MetaData button.
 
 ### Metafields
+
 There is also a provision to add more information about the format if the field is not included in the form. The user can use the [Metafields](/docs/features/extend-features) section by clicking on the Meta Fields section to feed in extra data as a JSON object.
 
 Customizing the header and footer specific to a format can be done by adding code in the Code Injection section by clicking on the Code Injection section.

diff --git a/website/docs/core-concepts/media.md b/website/docs/core-concepts/media.md
@@ -17,11 +17,12 @@ While uploading, basic editing options like crop, rotate, etc are provided.
 - Description: This allows users to describe the media
 - Delete button - To delete the media
 
-### Metafields 
+### Metafields
+
 There is also a provision to add more information about the media if the field is not included in the form. The user can use the [Metafields](/docs/features/extend-features) to feed in extra data as a JSON object.
 
 All the media will be available under the Media menu.
-Search and sort options are available to simplify the search for an image. To edit a Media click on the image in the list.
+[Search](/docs/features/search-and-filtering) and sort options are available to simplify the search for an image. To edit a Media click on the image in the list.
 
 ### Policies
 

diff --git a/website/docs/core-concepts/organisations.md b/website/docs/core-concepts/organisations.md
@@ -9,11 +9,10 @@ To access Dega, creating an organization is mandatory. The first organisation, c
 - The users within the Super Organisation will have access to all the other organisations and their spaces. This is for support staff to help other organisations with any support queries.
 - The admins within the Super Organisation will have admin access to the entire instance and will be able to manage the rest of the organisations and spaces. They have the ability to manage the usage limits for an oraganisation or spaces within.
 
-There is only one Super Organisation for a Dega instance but can create multiple Organisations as per user requirements. 
+There is only one Super Organisation for a Dega instance but can create multiple Organisations as per user requirements.
 
 - Admin of a normal organisation will have the access to manage its organisation and applications.
 - Applications to be used by an organization needs to be added from Kavach. For example, for an organisation to use Dega, it should be added from Kavach. Users can add default [Faclty applications](/docs/ecosystem/projects) from Kavach.
 - Basic Settings for the organization are managed from Kavach. For example, adding applications, changing logos, adding users, etc.
 - The organisation users to use applications of the organisation needs to be a part of that application. Admin of the organisation can provide users access to the applications.
-- Settings for Dega for an organisation can be configured from Organisation Request by making a request. 
-
+- Settings for Dega for an organisation can be configured from Organisation Request by making a request.