Skip to content

Commit

Permalink
Fix documentation typos (#45)
Browse files Browse the repository at this point in the history
  • Loading branch information
JackPGreen authored Oct 8, 2024
1 parent cae426d commit f4abc5a
Show file tree
Hide file tree
Showing 6 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions .github/CONTRIBUTING.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand Down Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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].
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/deploying/pages/data-policies.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/describing-data-sources/pages/databases.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/querying/pages/writing-queries.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit f4abc5a

Please sign in to comment.