Merge pull request #423 from factly/fix/core_concepts_docs

Documentation for core concepts

website/docs/core-concepts/categories.md

@@ -0,0 +1,48 @@
+---
+sidebar_position: 12
+---
+
+# Categories
+
+Categories help to group related posts.
+Users can add or assign categories while creating a post. While adding a category for a post, if a category does not exist then click on Create a Category. This allows users to quickly create a new category and assign it to a post.
+
+Category can be added from the Categories menu item by clicking on the New Category button on the right side.
+
+- Name: Name of a category
+- Parent Category: Select Parent category for the category
+- Featured - This field can be used to highlight the Category on the website if it is enabled.
+- Featured Image: Image of category
+- 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](/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
+
+The default policies for the categories are:
+
+- Admin, Editor and Author have the permission to read, create, update and delete the categories.
+  Apart from the default policies, the admin can customize the [policies](/docs/core-concepts/policies) from Policies Menu.
+
+### Events
+
+The defined events for the posts to trigger notification are:
+
+| 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 |
+
+These events can be registered while creating a webhook. These Events can be configured from [Events](/docs/core-concepts/events) menu.

website/docs/core-concepts/claimants.md

@@ -4,4 +4,45 @@ sidebar_position: 4
 
 # Claimants
 
-## Coming Soon!
+A claimant is a person who makes a claim. A claimant can be assigned to a claim while creating a claim.
+The user can add a claimant from the Claimants menu item by clicking on the New Claimant button on the right side.
+
+- Name - Name of the claimant.
+- Featured Image - Image for the claimant
+- Tag Line - Tag Line of the claimant
+- Featured - This field can be used to highlight the Claimant on the website if it is enabled.
+- 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](/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
+
+The default policies for the claimants are:
+
+- Editor and Admin have the permission to read, create, update and delete the claimants.
+- Author have the permission to read, create and update the claimants.
+- Contributor have the permission to read and create the claimants.
+  Apart from the default policies, the admin can customize the [policies](/docs/core-concepts/policies) from Policies Menu.
+
+### Events
+
+The defined events for the posts to trigger notification are:
+
+| Events          | Description                          |
+| --------------- | ------------------------------------ |
+| Create Claimant | Triggered when a claimant is added   |
+| Update Claimant | Triggered when a claimant is edited  |
+| Delete Claimant | Triggered when a claimant is deleted |
+
+These events can be registered while creating a webhook. These Events can be configured from [Events](/docs/core-concepts/events) menu.

website/docs/core-concepts/claims.md

@@ -4,4 +4,51 @@ sidebar_position: 3
 
 # Claims
 
-## Coming Soon!
+Claims given by any claimant can be added here. These claims can be assigned to a Fact-check. The user can add a claim from the Claims menu item by clicking on the New claim button on the right side.
+
+Claim Settings:
+
+- Claim - Title of the claim.
+- Fact - Facts about the claim.
+- [Claimant](/docs/core-concepts/claimants) - This allows you to add the claimant who made the claim
+- [Rating](/docs/core-concepts/ratings) - This allows you to rate the claim, i.e True, False, etc.
+- Claim Date - Date on which the claim was made
+- CheckedDate - Date on which the claim was checked by fact-checkers
+- Description - Describes what the claim is for.
+- Claim Sources - This allows you to add a list of claim sources.
+  By clicking on the Add Claim Sources button, new fields are added to add information about the claim sources. Url and description can be provided for each claim source.
+- Review Sources - This allows you to add a list of review sources.
+  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](/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
+
+The default policies for the claims are:
+
+- Editor and Admin have the permission to read, create, update and delete the claims.
+- Author and Contributor have the permission to read, create and update the claims.
+  Apart from the default policies, the admin can customize the [policies](/docs/core-concepts/policies) from Policies Menu.
+
+### Events
+
+The defined events for the posts to trigger notification are:
+
+| Events       | Description                       |
+| ------------ | --------------------------------- |
+| Create Claim | Triggered when a claim is added   |
+| Update Claim | Triggered when a claim is edited  |
+| Delete Claim | Triggered when a claim is deleted |
+
+These events can be registered while creating a webhook. These Events can be configured from [Events](/docs/core-concepts/events) menu.

website/docs/core-concepts/events.md

@@ -4,4 +4,62 @@ sidebar_position: 9
 
 # Events
 
-## Coming Soon
+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.
+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.
+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                 |

website/docs/core-concepts/fact-checks.md

@@ -4,4 +4,85 @@ sidebar_position: 2
 
 # Fact Checks
 
-## Coming Soon!
+Fact-checks are posts of format: fact-check. Fact-checks have all the features available in a regular post (format: default) and are extended to add features specific to fact-checking.
+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](/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.
+
+Each post created has status from any of the following.
+
+- Draft
+- Published
+- 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 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.
+
+The user can add information about the fact-check by clicking on the Settings button.
+
+- Featured Image - An image that is a pictorial representation of the content and can also be used as a thumbnail for the fact-check.
+- Excerpt - Brief description of the post
+- [Tags](/docs/core-concepts/tags) - This allows users to add or assign tags to the post
+- [Categories](/docs/core-concepts/categories) - This allows users to add or assign categories to the post
+- [Claims](docs/core-concepts/claims) - This allows users to add claims to the post. The user can either select from the existing list of claims or can create a new claim by clicking on the Add claim button.
+  When clicked on the Add Claim button, a modal popup opens to add in details about the claim.
+  A Fact-check can have multiple claims.
+- Authors - This allows users to add the author of the post
+- 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](/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.
+
+The quick edit option helps to quickly edit any fact-check post settings such as tags, categories, authors, claims, status, published date, title, etc.
+
+To view the total number of Fact-Checks, click on the Dashboard menu.
+It shows total Fact-checks as well as a count of Fact-Checks that are: draft, published, and ready to publish.
+
+### Policies
+
+The default policies for the fact-checks are:
+
+- Editor and Admin have the permission to read, create, update, delete and publish the fact-checks.
+- Author and Contributor have the permission to read, create and update the fact-checks.
+  Apart from the default policies, the admin can customize the [policies](/docs/core-concepts/policies) from Policies Menu.
+
+### Events
+
+The defined events for the fact-checks to trigger notification are:
+
+| Events          | Description                                        |
+| --------------- | -------------------------------------------------- |
+| 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 |
+
+These events can be registered while creating a webhook. These Events can be configured from [Events](/docs/core-concepts/events) menu.