Skip to content

Commit

Permalink
Merge pull request #313 from JackPGreen/Fix-typos-identified-by-IntelliJ
Browse files Browse the repository at this point in the history
Fix typos identified by IntelliJ
  • Loading branch information
JackPGreen authored Aug 23, 2023
2 parents 2d06ee7 + 20ccc64 commit 137fd6b
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions .github/CONTRIBUTING.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,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 @@ -141,7 +141,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
2 changes: 1 addition & 1 deletion README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ To automate some elements of the build process, this repository includes the fol
|Runs the link:{url-github-docsearch-scraper}[DocSearch scraper] in a Docker container to index the site and send the index to Algolia
|1st and 15th of every month at 00:00 UTC

NOTE: We used to run this one per day but it was causing overage charges. The crawler that we use uploads a temporary index before deleting the old one. This causes us to go over our limit more than three days in a month, which is the grace period that Algolia provides.
NOTE: We used to run this once per day, but it was causing overage charges. The crawler that we use uploads a temporary index before deleting the old one. This causes us to go over our limit more than three days in a month, which is the grace period that Algolia provides.

|publish-to-production.yml
|Merges the `develop` branch into the `main` branch to publish changes on the staging site to production.
Expand Down

0 comments on commit 137fd6b

Please sign in to comment.