From f4abc5a95a342545ac01d90d53f4767d1268c81e Mon Sep 17 00:00:00 2001 From: Jack Green Date: Tue, 8 Oct 2024 17:42:01 +0100 Subject: [PATCH] Fix documentation typos (#45) --- .github/CONTRIBUTING.adoc | 4 ++-- .../connecting-data-sources/pages/connecting-a-database.adoc | 2 +- .../pages/schema-publication-methods.adoc | 2 +- docs/modules/deploying/pages/data-policies.adoc | 2 +- docs/modules/describing-data-sources/pages/databases.adoc | 2 +- docs/modules/querying/pages/writing-queries.adoc | 2 +- 6 files changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/CONTRIBUTING.adoc b/.github/CONTRIBUTING.adoc index 36ddba3..ca06de9 100644 --- a/.github/CONTRIBUTING.adoc +++ b/.github/CONTRIBUTING.adoc @@ -27,7 +27,7 @@ If no version number is displayed in the output, you need to {url-node}[install === Step 2. Clone a documentation project -Documentation is hosted in xref:{url-readme}#documentation-content[separate GitHub repositorites]. To work on a particular documentation project, you must fork it, clone it, and configure the `antora-playbook-local.yml` file to process your local version. +Documentation is hosted in xref:{url-readme}#documentation-content[separate GitHub repositories]. To work on a particular documentation project, you must fork it, clone it, and configure the `antora-playbook-local.yml` file to process your local version. NOTE: You can find all content repositories in the `antora-playbook.yml` file under `content.sources`. @@ -140,7 +140,7 @@ modules/ <2> ---- <1> This file tells Antora that the contents of the `modules/` folder should be processed and added to the documentation site. This file is called the {url-antora-yml}[component version descriptor file]. <2> This folder contains the content that Antora will process -<3> This folder contains any content that can't be categorized under a specfic module name. Unlike other modules, the name of this module is never displayed in the URL of the site. +<3> This folder contains any content that can't be categorized under a specific module name. Unlike other modules, the name of this module is never displayed in the URL of the site. <4> In any module, this folder contains downloadable content such as ZIP files that a user can download through a link. <5> In any module, this folder contains examples such as source code that you can include in Asciidoc pages. <6> In any module, this folder contains images that you can include in Asciidoc pages. diff --git a/docs/modules/connecting-data-sources/pages/connecting-a-database.adoc b/docs/modules/connecting-data-sources/pages/connecting-a-database.adoc index 15e94e3..71667f6 100644 --- a/docs/modules/connecting-data-sources/pages/connecting-a-database.adoc +++ b/docs/modules/connecting-data-sources/pages/connecting-a-database.adoc @@ -100,7 +100,7 @@ jdbc { # The root element for database connections For the full specification, including supported database drivers and their connection details, see xref:describing-data-sources:configuring-connections.adoc[Configure connections] === Passing sensitive data -It may not always be desirable to specify sensistive connection information directly in the config file, especially +It may not always be desirable to specify sensitive connection information directly in the config file, especially if these are being checked into source control. Environment variables can be used anywhere in the config file, following the https://github.com/lightbend/config#uses-of-substitutions[HOCON standards]. diff --git a/docs/modules/connecting-data-sources/pages/schema-publication-methods.adoc b/docs/modules/connecting-data-sources/pages/schema-publication-methods.adoc index 0e72318..3c90bcd 100644 --- a/docs/modules/connecting-data-sources/pages/schema-publication-methods.adoc +++ b/docs/modules/connecting-data-sources/pages/schema-publication-methods.adoc @@ -170,7 +170,7 @@ Cons: * OpenAPI endpoints * HTTP servers -This is a strong option for scenarios where sytems can't publish their own schemas (eg., databases), +This is a strong option for scenarios where systems can't publish their own schemas (eg., databases), or for data sources that are otherwise structureless (eg., CSV files). Additionally, using a git-backed repository for a shared glossary / taxonomy is a great way to diff --git a/docs/modules/deploying/pages/data-policies.adoc b/docs/modules/deploying/pages/data-policies.adoc index 27a372b..903baae 100644 --- a/docs/modules/deploying/pages/data-policies.adoc +++ b/docs/modules/deploying/pages/data-policies.adoc @@ -57,7 +57,7 @@ Similar to how you can use claims from your IDP, to pass through to a data sourc Policies can be defined against any data that is discoverable using a {short-product-name} query - not just the values present on the inbound claim. - A seperate subquery is executed to discover data that is needed to evaluate the policy. + A separate subquery is executed to discover data that is needed to evaluate the policy. For example: diff --git a/docs/modules/describing-data-sources/pages/databases.adoc b/docs/modules/describing-data-sources/pages/databases.adoc index 252539a..d23a14d 100644 --- a/docs/modules/describing-data-sources/pages/databases.adoc +++ b/docs/modules/describing-data-sources/pages/databases.adoc @@ -369,7 +369,7 @@ No schema migrations are performed. === Example queries When writing data from one data source into a database, it's not -neccessary for the data to align with the format of the + necessary for the data to align with the format of the persisted value. {short-product-name} will automatically adapt the incoming data to the diff --git a/docs/modules/querying/pages/writing-queries.adoc b/docs/modules/querying/pages/writing-queries.adoc index 9dc1394..6a4afaf 100644 --- a/docs/modules/querying/pages/writing-queries.adoc +++ b/docs/modules/querying/pages/writing-queries.adoc @@ -401,7 +401,7 @@ TaxiQL queries with any of the following content types headers: * `Content-Type: application/taxiql` * `Content-Type: text/plain` -This is to allow broad compatability with clients. +This is to allow broad compatibility with clients. === Large queries with server-sent events