Formatting adjustments to docs (#1894)

* Update overview-main.md * Add formatting line breaks.
sodadata · Jun 15, 2023 · 5d482e5 · 5d482e5
1 parent a659538
commit 5d482e5
Show file tree

Hide file tree

Showing 7 changed files with 38 additions and 38 deletions.
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -4,10 +4,10 @@ After you [install Soda Core](/docs/installation.md), you must create a `configu
 
 Alternatively, you can provide data source connection configurations in the context of a [programmatic scan](/docs/programmatic.md), if you wish.
 
-[Configuration instructions](#configuration-instructions)
-[Provide credentials as system variables](#provide-credentials-as-system-variables)
-[Disable failed rows samples for specific columns](#disable-failed-rows-samples-for-specific-columns)
-[Disable failed rows samples for individual checks](#disable-failed-row-samples-for-individual-checks)
+[Configuration instructions](#configuration-instructions)<br />
+[Provide credentials as system variables](#provide-credentials-as-system-variables)<br />
+[Disable failed rows samples for specific columns](#disable-failed-rows-samples-for-specific-columns)<br />
+[Disable failed rows samples for individual checks](#disable-failed-row-samples-for-individual-checks)<br />
 <br />
 
 ## Configuration instructions

diff --git a/docs/how-core-works.md b/docs/how-core-works.md
@@ -7,9 +7,9 @@ When checks fail, they surface the data that you defined as "bad" in the check.
 Use Soda Core on its own to manually or programmatically scan the data that your organization uses to make decisions. Optionally, you can integrate Soda Core with your data orchestration tool to schedule scans and automate actions based on scan results. 
 
 
-[Soda Core basics](#soda-core-basics)
-[Soda Core operation](#soda-core-operation)
-[Soda Core automation and integrations](#soda-core-automation-and-integrations)
+[Soda Core basics](#soda-core-basics)<br />
+[Soda Core operation](#soda-core-operation)<br />
+[Soda Core automation and integrations](#soda-core-automation-and-integrations)<br />
 
 
 ## Soda Core basics

diff --git a/docs/installation.md b/docs/installation.md
@@ -5,13 +5,13 @@
 Alternatively, you can use the Soda Core Python library to programmatically execute scans; see [Define programmatic scans using Python](/docs/programmatic.md).
 <br />
 
-[Compatibility](#compatibility)
-[Requirements](#requirements)
-[Install on MacOS, Linux](#install-on-macos-linux)
-[Install on Windows](#install-on-windows)
-[Install using Docker](#install-using-docker)
-[Upgrade](#upgrade)
-[Install Soda Core Scientific](#install-soda-core-scientific)
+[Compatibility](#compatibility)<br />
+[Requirements](#requirements)<br />
+[Install on MacOS, Linux](#install-on-macos-linux)<br />
+[Install on Windows](#install-on-windows)<br />
+[Install using Docker](#install-using-docker)<br />
+[Upgrade](#upgrade)<br />
+[Install Soda Core Scientific](#install-soda-core-scientific)<br />
 
 ## Compatibility
 

diff --git a/docs/orchestrate-scans.md b/docs/orchestrate-scans.md
@@ -4,10 +4,10 @@ Integrate Soda Core with a data orchestration tool such as, Airflow, to automate
 
 Configure actions that the orchestration tool can take based on scan output. For example, if the output of a scan reveals a large number of failed tests, the orchestration tool can automatically block "bad" data from contaminating your data pipeline.
 
-[Apache Airflow using BashOperator](#apache-airflow-using-bashoperator)
-[Apache Airflow using PythonOperator](#apache-airflow-using-pythonoperator)
-&nbsp;&nbsp;&nbsp;&nbsp; [Example DAG](#example-dag)
-[Soda Core and Prefect](#soda-core-and-prefect)
+[Apache Airflow using BashOperator](#apache-airflow-using-bashoperator)<br />
+[Apache Airflow using PythonOperator](#apache-airflow-using-pythonoperator)<br />
+&nbsp;&nbsp;&nbsp;&nbsp; [Example DAG](#example-dag)<br />
+[Soda Core and Prefect](#soda-core-and-prefect)<br />
 <br />
 
 ## Apache Airflow using BashOperator

diff --git a/docs/overview-main.md b/docs/overview-main.md
@@ -1,9 +1,9 @@
 # Soda Core overview
 
-&#10004;  An open-source, CLI tool and Python library for data reliability
-&#10004;  Compatible with [Soda Checks Language (SodaCL)](https://docs.soda.io/soda-cl/soda-cl-overview.html) 
-&#10004;  Enables data quality testing both in and out of your [data pipeline](/docs/orchestrate-scans.md), for data observability and reliability 
-&#10004;  Enables [programmatic scans](/docs/programmatic.md) on a time-based schedule 
+&#10004;  An open-source, CLI tool and Python library for data reliability<br />
+&#10004;  Compatible with [Soda Checks Language (SodaCL)](https://docs.soda.io/soda-cl/soda-cl-overview.html) <br />
+&#10004;  Enables data quality testing both in and out of your [data pipeline](/docs/orchestrate-scans.md), for data observability and reliability <br />
+&#10004;  Enables [programmatic scans](/docs/programmatic.md) on a time-based schedule <br />
 <br />
 
 #### Example checks
@@ -52,10 +52,10 @@ checks for dim_department_group:
 ```
 
 ## Get started
-[Download and install Soda Core](/docs/installation.md) 
-[Prepare a configuration.yml file](/docs/configuration.md)
-[Write checks in a checks.yml file](https://docs.soda.io/soda/quick-start-sodacl.html)
-[Run a scan](/docs/scan-core.md)
+[Download and install Soda Core](/docs/installation.md) <br />
+[Prepare a configuration.yml file](/docs/configuration.md)<br />
+[Write checks in a checks.yml file](https://docs.soda.io/soda/quick-start-sodacl.html)<br />
+[Run a scan](/docs/scan-core.md)<br />
 
 
 ## Why Soda Core?

diff --git a/docs/programmatic.md b/docs/programmatic.md
@@ -6,11 +6,11 @@ Alternatively, you can install and use the Soda Core CLI to run scans; see [Inst
 
 Based on a set of conditions or a specific event schedule, you can instruct Soda Core to automatically scan a data source. For example, you may wish to scan your data at several points along your data pipeline, perhaps when new data enters a data source, after it is transformed, and before it is exported to another data source.
 
-[Basic programmatic scan](#basic-programmatic-scan)
-[Tips and best practices](#tips-and-best-practices)
-[Scan exit codes](#scan-exit-codes)
-[Configure a failed row sampler](#configure-a-failed-row-sampler)
-[Save failed row samples to an alternate destination](#save-failed-row-samples-to-an-alternate-destination)
+[Basic programmatic scan](#basic-programmatic-scan)<br />
+[Tips and best practices](#tips-and-best-practices)<br />
+[Scan exit codes](#scan-exit-codes)<br />
+[Configure a failed row sampler](#configure-a-failed-row-sampler)<br />
+[Save failed row samples to an alternate destination](#save-failed-row-samples-to-an-alternate-destination)<br />
 <br />
 
 ## Basic programmatic scan

diff --git a/docs/scan-core.md b/docs/scan-core.md
@@ -8,13 +8,13 @@ soda scan -d postgres_retail_db  -c configuration.yml checks.yml
 
 A **check** is a test that Soda Core performs when it scans a dataset in your data source. Soda Core uses the checks you define in the **checks YAML** file to prepare SQL queries that it runs against the data in a table. Soda Core can execute multiple checks against one or more datasets in a single scan. 
 
-[Anatomy of a scan command](#anatomy-of-a-scan-command)
-[Variables](#variables)
-[Scan output](#scan-output)
-[Examine a scan's SQL queries](#examine-a-scans-sql-queries)
-[Programmatically use scan output](#programmatically-use-scan-output)
-[Add scan options](#add-scan-options)
-[Troubleshoot](#troubleshoot)
+[Anatomy of a scan command](#anatomy-of-a-scan-command)<br />
+[Variables](#variables)<br />
+[Scan output](#scan-output)<br />
+[Examine a scan's SQL queries](#examine-a-scans-sql-queries)<br />
+[Programmatically use scan output](#programmatically-use-scan-output)<br />
+[Add scan options](#add-scan-options)<br />
+[Troubleshoot](#troubleshoot)<br />
 <br />
 
 ## Anatomy of a scan command