Skip to content

docs: consistent wording #1419

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
samsja merged 2 commits into from
Apr 18, 2023
Merged

docs: consistent wording #1419

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4d0d687
docs: rename overview to introduction
alexcg1 Apr 18, 2023
b3ffc33
docs: elasticsearch capitalization
alexcg1 Apr 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/user_guide/storing/first_step.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Overview
# Introduction

In the previous sections we saw how to use [`BaseDoc`][docarray.base_doc.doc.BaseDoc], [`DocList`][docarray.array.doc_list.doc_list.DocList] and [`DocVec`][docarray.array.doc_vec.doc_vec.DocVec] to represent multi-modal data and send it over the wire.
In this section we will see how to store and persist this data.
Expand Down
2 changes: 1 addition & 1 deletion docs/user_guide/storing/first_steps.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Overview
# Introduction

A Document Index lets you store your Documents and search through them using vector similarity.

Expand Down
6 changes: 3 additions & 3 deletions docs/user_guide/storing/index_elastic.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ElasticSearch Document Index
# Elasticsearch Document Index

DocArray comes with two Document Indexes for [Elasticsearch](https://www.elastic.co/elasticsearch/):

Expand Down Expand Up @@ -33,7 +33,7 @@ DocArray comes with two Document Indexes for [Elasticsearch](https://www.elastic
The following examples is based on [ElasticDocIndex][docarray.index.backends.elastic.ElasticDocIndex],
but will also work for [ElasticV7DocIndex][docarray.index.backends.elasticv7.ElasticV7DocIndex].

# Start ElasticSearch
# Start Elasticsearch

You can use docker-compose to create a local Elasticsearch service with the following `docker-compose.yml`.

Expand Down Expand Up @@ -433,4 +433,4 @@ doc_index = ElasticDocIndex[SimpleDoc]()
```

You can pass the above as a keyword arguments the `configure()` method or pass an entire configuration object.
To see how, see [here](first_steps.md#configuration-options#customize-configurations).
To see how, see [here](first_steps.md#configuration-options#customize-configurations).