Skip to content

Commit 4b8d62d

Browse files
Fix typos and grammar errors in documentation (#5506)
* fix: correct typos and grammar errors in documentation * revert * Lint --------- Co-authored-by: Olga Bulat <[email protected]>
1 parent 7d16e1b commit 4b8d62d

File tree

4 files changed

+7
-7
lines changed

4 files changed

+7
-7
lines changed

documentation/api/guides/documentation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Framework API.
1313

1414
- Run the server locally by following the [API quickstart guide](quickstart.md)
1515
- Update documentation
16-
- Make sure the updates passed the automated tests in defined in our
16+
- Make sure the updates passed the automated tests defined in our
1717
[CI/CD workflow](/meta/ci_cd/index.md)
1818
- Commit and push
1919
- Create pull request by following our

documentation/api/reference/search_algorithm.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ documentation on this page was written by referencing the code in Openverse as
66
well as parts of Openverse's historical development. Parts of the story for how
77
Openverse's indexes came to be configured as they are today are likely missing.
88
Future improvements to Openverse's indexing and search will be more carefully
9-
documented here and in the code to ensure there is greater longevitiy of
9+
documented here and in the code to ensure there is greater longevity of
1010
understanding.
1111

1212
> **Note**: This document avoids covering details covered in the
@@ -23,7 +23,7 @@ about Elasticsearch, full text-search, and Openverse's index configuration:
2323
- [Elasticsearch 7.12 documentation](https://www.elastic.co/guide/en/elasticsearch/reference/7.12/index.html)
2424
- [Full-text search (Wikipedia)](https://en.wikipedia.org/wiki/Full-text_search)
2525
- [Stemming (Wikipedia)](https://en.wikipedia.org/wiki/Stemming)
26-
- [`es_mapping.py` (index configuration)](https://github.com/WordPress/openverse-api/blob/main/ingestion_server/ingestion_server/es_mapping.py)
26+
- [`es_mapping.py` (index configuration)](https://github.com/WordPress/openverse/blob/main/ingestion_server/ingestion_server/es_mapping.py)
2727

2828
## Terms
2929

@@ -211,8 +211,8 @@ These are the fields currently supported for individual field querying:
211211
212212
Each of these can be stacked. You can make a request that queries for a specific
213213
title by a specific creator. The following parameters would search only for
214-
works by "Claude Monet" where the word "madame" (or it's stemmed versions)
215-
appear in the title: `?creator=Claude Monet&title=madame`.
214+
works by "Claude Monet" where the word "madame" (or its stemmed versions) appear
215+
in the title: `?creator=Claude Monet&title=madame`.
216216

217217
As you can see, this is unique from the general query searching in that it
218218
allows you to apply separate queries for individual fields (hence the name

documentation/catalog/guides/adding_a_new_provider.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ generated for each provider. A simple provider DAG looks like this:
1212

1313
At a high level the steps are:
1414

15-
1. `generate_filename`: Generates the named of a TSV (tab-separated values) text
15+
1. `generate_filename`: Generates the name of a TSV (tab-separated values) text
1616
file that will be used for saving the data to the disk in later steps
1717
2. `pull_data`: Pulls records from the provider API, collects just the data we
1818
need, and commits it to local storage in TSVs.

documentation/frontend/guides/analytics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Plausible supports custom events via its "goals" feature.
5050

5151
Sending custom events to Plausible is done by calling the `sendCustomEvents`
5252
function. For this function to accept a custom event name, you must update the
53-
`Events` type in `frontend/src/types/analyticts.ts` to include the new event
53+
`Events` type in `frontend/shared/types/analytics.ts` to include the new event
5454
name and any payload elements unique to the event.
5555

5656
Custom events must be added to Plausible for it to record them. You may do this

0 commit comments

Comments
 (0)