Skip to content

Commit b44728d

Browse files
authored
Merge pull request #2147 from Danielle9897/RDoc-3512-fixLinkToPythonClient
RDoc-3512 Getting started page links to the legacy Python client
2 parents 90b7615 + 423b14c commit b44728d

File tree

5 files changed

+110
-75
lines changed

5 files changed

+110
-75
lines changed

docs/start/getting-started.mdx

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,22 @@ import LanguageSwitcher from "@site/src/components/LanguageSwitcher";
1313
import LanguageContent from "@site/src/components/LanguageContent";
1414

1515
# Getting Started
16+
1617
<Admonition type="note" title="">
1718

1819
Welcome to RavenDB!
1920

20-
This article will get you started and guide you through all the aspects of RavenDB needed for basic understanding and a simple setup.
21+
* This article will get you started with RavenDB, covering the essentials for a simple setup and basic usage.
2122

22-
* In this page:
23-
* The [Server](../start/getting-started.mdx#server) portion will focus on installation, setup & configuration of the RavenDB server
23+
* The [Server section](../start/getting-started.mdx#server) covers installation, setup, and configuration of the RavenDB server:
2424
* [Prerequisites](../start/getting-started.mdx#prerequisites)
2525
* [Installation & Setup](../start/getting-started.mdx#installation--setup)
2626
* [Configuration](../start/getting-started.mdx#configuration)
2727
* [Studio](../start/getting-started.mdx#studio)
2828
* [Security Concerns](../start/getting-started.mdx#security-concerns)
29-
* The [Client](../start/getting-started.mdx#client) portion will describe the general logic and principles behind our client libraries
29+
30+
* The [Client section](../start/getting-started.mdx#client) shows how to connect your application to the RavenDB server
31+
and begin working with documents using a client library:
3032
* [DocumentStore](../start/getting-started.mdx#documentstore)
3133
* [Session](../start/getting-started.mdx#session)
3234

@@ -44,6 +46,7 @@ RavenDB is cross-platform with support for the following operating systems:
4446
- Docker
4547
- MacOS
4648
- Raspberry Pi
49+
4750
### Prerequisites
4851

4952
RavenDB is written in `.NET` so it requires the same set of prerequisites as `.NET`.
@@ -72,6 +75,7 @@ in this [Microsoft article](https://learn.microsoft.com/en-us/dotnet/core/instal
7275
launching the RavenDB Server.
7376

7477
</Admonition>
78+
7579
### Installation & Setup
7680

7781
<Admonition type="note" title="Highly Available Clusters" id="highly-available-clusters" href="#highly-available-clusters">
@@ -144,6 +148,7 @@ appearing:
144148
`<Studio URL>#dashboard?disableAnalytics=true`
145149

146150
</Admonition>
151+
147152
### Configuration
148153

149154
The RavenDB server uses a [settings.json](../server/configuration/configuration-options.mdx#settingsjson) file in each node `Server` folder to store the server-wide configuration options.
@@ -197,6 +202,7 @@ RavenDB requires write permissions to the following locations:
197202
If you intend to run as a service, the write permissions should be granted to the user running the service (e.g. "Local Service").
198203

199204
</Admonition>
205+
200206
### Studio
201207

202208
<Admonition type="note" title="Free" id="free" href="#free">
@@ -211,6 +217,7 @@ Our GUI, the RavenDB Management Studio, comes **free** with **every license type
211217

212218
After installation and setup, the Studio can be accessed via the browser using the `ServerUrl` or the `ServerPublicUrl` value e.g. `http://localhost:8080`.
213219
Whenever you run the server folder script `run.ps1` the Studio opens automatically in your browser.
220+
214221
### Security Concerns
215222

216223
**We recommend using the 'Setup Wizard' to easily install RavenDB securely from the very start** to prevent potential future vulnerability.
@@ -231,20 +238,22 @@ access control to prevent unauthorized access to your data or to explicitly allo
231238

232239
Read more about security and how to [enable authentication here](../server/security/overview.mdx).
233240

234-
241+
---
235242

236243
## Client
237244

238-
After your server is up and running, to write an application you need to acquire one of the `Client` access libraries:
245+
Once the server is up and running, you can start building your application using one of RavenDB’s official client libraries.
246+
These libraries manage the connection to the server, handle document storage and retrieval, and give you full access to RavenDB features in your programming language.
239247

240-
- .NET from [NuGet](https://www.nuget.org/packages/RavenDB.Client/)
241-
- Java from [Maven](https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22net.ravendb%22%20AND%20a%3A%22ravendb%22)
242-
- Node.js from [NPM](https://www.npmjs.com/package/ravendb)
243-
- Python from [PyPi](https://pypi.org/project/pyravendb/)
244-
- [Ruby](https://github.com/ravendb/ravendb-ruby-client)
245-
- [Go](https://github.com/ravendb/ravendb-go-client)
248+
Client libraries are available for the following languages:
246249

247-
---
250+
* .NET - `RavenDB.Client` on [NuGet](https://www.nuget.org/packages/RavenDB.Client/)
251+
* Java - `ravendb` on [Maven Central](https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22net.ravendb%22%20AND%20a%3A%22ravendb%22)
252+
* Node.js - `ravendb` on [NPM](https://www.npmjs.com/package/ravendb)
253+
* Python - `ravendb` on [PyPI](https://pypi.org/project/ravendb/)
254+
* PHP - `ravendb-php-client` on [GitHub](https://github.com/ravendb/ravendb-php-client)
255+
* Ruby - `ravendb-ruby-client` on [GitHub](https://github.com/ravendb/ravendb-ruby-client)
256+
* Go - `ravendb-go-client` on [GitHub](https://github.com/ravendb/ravendb-go-client)
248257

249258
### DocumentStore
250259

@@ -334,8 +343,6 @@ The following articles can extend your knowledge about the `DocumentStore` and i
334343
- [How to Setup a Default Database?](../client-api/setting-up-default-database.mdx)
335344
- [How to configure the Document Store using Conventions?](../client-api/configuration/conventions.mdx)
336345

337-
---
338-
339346
### Session
340347

341348
The `Session` is used to manipulate the data. It implements the `Unit of Work` pattern and is capable of batching the requests to save expensive remote calls. In contrast to a `DocumentStore` it is a lightweight object and can be created more frequently. For example, in web applications, a common (and recommended) pattern is to create a session per request.

versioned_docs/version-5.4/start/getting-started.mdx

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,22 @@ import LanguageSwitcher from "@site/src/components/LanguageSwitcher";
1313
import LanguageContent from "@site/src/components/LanguageContent";
1414

1515
# Getting Started
16+
1617
<Admonition type="note" title="">
1718

1819
Welcome to RavenDB!
1920

20-
This article will get you started and guide you through all the aspects of RavenDB needed for basic understanding and a simple setup.
21+
* This article will get you started with RavenDB, covering the essentials for a simple setup and basic usage.
2122

22-
* In this page:
23-
* The [Server](../start/getting-started.mdx#server) portion will focus on installation, setup & configuration of the RavenDB server
23+
* The [Server section](../start/getting-started.mdx#server) covers installation, setup, and configuration of the RavenDB server:
2424
* [Prerequisites](../start/getting-started.mdx#prerequisites)
2525
* [Installation & Setup](../start/getting-started.mdx#installation--setup)
2626
* [Configuration](../start/getting-started.mdx#configuration)
2727
* [Studio](../start/getting-started.mdx#studio)
2828
* [Security Concerns](../start/getting-started.mdx#security-concerns)
29-
* The [Client](../start/getting-started.mdx#client) portion will describe the general logic and principles behind our client libraries
29+
30+
* The [Client section](../start/getting-started.mdx#client) shows how to connect your application to the RavenDB server
31+
and begin working with documents using a client library:
3032
* [DocumentStore](../start/getting-started.mdx#documentstore)
3133
* [Session](../start/getting-started.mdx#session)
3234

@@ -44,6 +46,7 @@ RavenDB is cross-platform with support for the following operating systems:
4446
- Docker
4547
- MacOS
4648
- Raspberry Pi
49+
4750
### Prerequisites
4851

4952
RavenDB is written in .NET Core so it requires the same set of prerequisites as .NET Core.
@@ -65,6 +68,7 @@ We highly recommend **updating** your **Linux OS** prior to launching the RavenD
6568
We highly recommend **updating** your **MacOS** and checking the [Prerequisites for .NET Core on macOS](https://docs.microsoft.com/en-us/dotnet/core/macos-prerequisites) article written by Microsoft before launching the RavenDB Server.
6669

6770
</Admonition>
71+
6872
### Installation & Setup
6973

7074
<Admonition type="note" title="Highly Available Clusters" id="highly-available-clusters" href="#highly-available-clusters">
@@ -137,6 +141,7 @@ appearing:
137141
`<Studio URL>#dashboard?disableAnalytics=true`
138142

139143
</Admonition>
144+
140145
### Configuration
141146

142147
The RavenDB server uses a [settings.json](../server/configuration/configuration-options.mdx#settingsjson) file in each node `Server` folder to store the server-wide configuration options.
@@ -190,6 +195,7 @@ RavenDB requires write permissions to the following locations:
190195
If you intend to run as a service, the write permissions should be granted to the user running the service (e.g. "Local Service").
191196

192197
</Admonition>
198+
193199
### Studio
194200

195201
<Admonition type="note" title="Free" id="free" href="#free">
@@ -204,6 +210,7 @@ Our GUI, the RavenDB Management Studio, comes **free** with **every license type
204210

205211
After installation and setup, the Studio can be accessed via the browser using the `ServerUrl` or the `ServerPublicUrl` value e.g. `http://localhost:8080`.
206212
Whenever you run the server folder script `run.ps1` the Studio opens automatically in your browser.
213+
207214
### Security Concerns
208215

209216
**We recommend using the 'Setup Wizard' to easily install RavenDB securely from the very start** to prevent potential future vulnerability.
@@ -224,20 +231,22 @@ access control to prevent unauthorized access to your data or to explicitly allo
224231

225232
Read more about security and how to [enable authentication here](../server/security/overview.mdx).
226233

227-
234+
---
228235

229236
## Client
230237

231-
After your server is up and running, to write an application you need to acquire one of the `Client` access libraries:
238+
Once the server is up and running, you can start building your application using one of RavenDB’s official client libraries.
239+
These libraries manage the connection to the server, handle document storage and retrieval, and give you full access to RavenDB features in your programming language.
232240

233-
- .NET from [NuGet](https://www.nuget.org/packages/RavenDB.Client/)
234-
- Java from [Maven](https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22net.ravendb%22%20AND%20a%3A%22ravendb%22)
235-
- Node.js from [NPM](https://www.npmjs.com/package/ravendb)
236-
- Python from [PyPi](https://pypi.org/project/pyravendb/)
237-
- [Ruby](https://github.com/ravendb/ravendb-ruby-client)
238-
- [Go](https://github.com/ravendb/ravendb-go-client)
241+
Client libraries are available for the following languages:
239242

240-
---
243+
* .NET - `RavenDB.Client` on [NuGet](https://www.nuget.org/packages/RavenDB.Client/)
244+
* Java - `ravendb` on [Maven Central](https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22net.ravendb%22%20AND%20a%3A%22ravendb%22)
245+
* Node.js - `ravendb` on [NPM](https://www.npmjs.com/package/ravendb)
246+
* Python - `ravendb` on [PyPI](https://pypi.org/project/ravendb/)
247+
* PHP - `ravendb-php-client` on [GitHub](https://github.com/ravendb/ravendb-php-client)
248+
* Ruby - `ravendb-ruby-client` on [GitHub](https://github.com/ravendb/ravendb-ruby-client)
249+
* Go - `ravendb-go-client` on [GitHub](https://github.com/ravendb/ravendb-go-client)
241250

242251
### DocumentStore
243252

@@ -326,8 +335,6 @@ The following articles can extend your knowledge about the `DocumentStore` and i
326335
- [How to Setup a Default Database?](../client-api/setting-up-default-database.mdx)
327336
- [How to configure the Document Store using Conventions?](../client-api/configuration/conventions.mdx)
328337

329-
---
330-
331338
### Session
332339

333340
The `Session` is used to manipulate the data. It implements the `Unit of Work` pattern and is capable of batching the requests to save expensive remote calls. In contrast to a `DocumentStore` it is a lightweight object and can be created more frequently. For example, in web applications, a common (and recommended) pattern is to create a session per request.

versioned_docs/version-6.0/start/getting-started.mdx

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,22 @@ import LanguageSwitcher from "@site/src/components/LanguageSwitcher";
1313
import LanguageContent from "@site/src/components/LanguageContent";
1414

1515
# Getting Started
16+
1617
<Admonition type="note" title="">
1718

1819
Welcome to RavenDB!
1920

20-
This article will get you started and guide you through all the aspects of RavenDB needed for basic understanding and a simple setup.
21+
* This article will get you started with RavenDB, covering the essentials for a simple setup and basic usage.
2122

22-
* In this page:
23-
* The [Server](../start/getting-started.mdx#server) portion will focus on installation, setup & configuration of the RavenDB server
23+
* The [Server section](../start/getting-started.mdx#server) covers installation, setup, and configuration of the RavenDB server:
2424
* [Prerequisites](../start/getting-started.mdx#prerequisites)
2525
* [Installation & Setup](../start/getting-started.mdx#installation--setup)
2626
* [Configuration](../start/getting-started.mdx#configuration)
2727
* [Studio](../start/getting-started.mdx#studio)
2828
* [Security Concerns](../start/getting-started.mdx#security-concerns)
29-
* The [Client](../start/getting-started.mdx#client) portion will describe the general logic and principles behind our client libraries
29+
30+
* The [Client section](../start/getting-started.mdx#client) shows how to connect your application to the RavenDB server
31+
and begin working with documents using a client library:
3032
* [DocumentStore](../start/getting-started.mdx#documentstore)
3133
* [Session](../start/getting-started.mdx#session)
3234

@@ -44,6 +46,7 @@ RavenDB is cross-platform with support for the following operating systems:
4446
- Docker
4547
- MacOS
4648
- Raspberry Pi
49+
4750
### Prerequisites
4851

4952
RavenDB is written in `.NET` so it requires the same set of prerequisites as `.NET`.
@@ -72,6 +75,7 @@ in this [Microsoft article](https://learn.microsoft.com/en-us/dotnet/core/instal
7275
launching the RavenDB Server.
7376

7477
</Admonition>
78+
7579
### Installation & Setup
7680

7781
<Admonition type="note" title="Highly Available Clusters" id="highly-available-clusters" href="#highly-available-clusters">
@@ -144,6 +148,7 @@ appearing:
144148
`<Studio URL>#dashboard?disableAnalytics=true`
145149

146150
</Admonition>
151+
147152
### Configuration
148153

149154
The RavenDB server uses a [settings.json](../server/configuration/configuration-options.mdx#settingsjson) file in each node `Server` folder to store the server-wide configuration options.
@@ -197,6 +202,7 @@ RavenDB requires write permissions to the following locations:
197202
If you intend to run as a service, the write permissions should be granted to the user running the service (e.g. "Local Service").
198203

199204
</Admonition>
205+
200206
### Studio
201207

202208
<Admonition type="note" title="Free" id="free" href="#free">
@@ -211,6 +217,7 @@ Our GUI, the RavenDB Management Studio, comes **free** with **every license type
211217

212218
After installation and setup, the Studio can be accessed via the browser using the `ServerUrl` or the `ServerPublicUrl` value e.g. `http://localhost:8080`.
213219
Whenever you run the server folder script `run.ps1` the Studio opens automatically in your browser.
220+
214221
### Security Concerns
215222

216223
**We recommend using the 'Setup Wizard' to easily install RavenDB securely from the very start** to prevent potential future vulnerability.
@@ -231,20 +238,22 @@ access control to prevent unauthorized access to your data or to explicitly allo
231238

232239
Read more about security and how to [enable authentication here](../server/security/overview.mdx).
233240

234-
241+
---
235242

236243
## Client
237244

238-
After your server is up and running, to write an application you need to acquire one of the `Client` access libraries:
245+
Once the server is up and running, you can start building your application using one of RavenDB’s official client libraries.
246+
These libraries manage the connection to the server, handle document storage and retrieval, and give you full access to RavenDB features in your programming language.
239247

240-
- .NET from [NuGet](https://www.nuget.org/packages/RavenDB.Client/)
241-
- Java from [Maven](https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22net.ravendb%22%20AND%20a%3A%22ravendb%22)
242-
- Node.js from [NPM](https://www.npmjs.com/package/ravendb)
243-
- Python from [PyPi](https://pypi.org/project/pyravendb/)
244-
- [Ruby](https://github.com/ravendb/ravendb-ruby-client)
245-
- [Go](https://github.com/ravendb/ravendb-go-client)
248+
Client libraries are available for the following languages:
246249

247-
---
250+
* .NET - `RavenDB.Client` on [NuGet](https://www.nuget.org/packages/RavenDB.Client/)
251+
* Java - `ravendb` on [Maven Central](https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22net.ravendb%22%20AND%20a%3A%22ravendb%22)
252+
* Node.js - `ravendb` on [NPM](https://www.npmjs.com/package/ravendb)
253+
* Python - `ravendb` on [PyPI](https://pypi.org/project/ravendb/)
254+
* PHP - `ravendb-php-client` on [GitHub](https://github.com/ravendb/ravendb-php-client)
255+
* Ruby - `ravendb-ruby-client` on [GitHub](https://github.com/ravendb/ravendb-ruby-client)
256+
* Go - `ravendb-go-client` on [GitHub](https://github.com/ravendb/ravendb-go-client)
248257

249258
### DocumentStore
250259

@@ -334,8 +343,6 @@ The following articles can extend your knowledge about the `DocumentStore` and i
334343
- [How to Setup a Default Database?](../client-api/setting-up-default-database.mdx)
335344
- [How to configure the Document Store using Conventions?](../client-api/configuration/conventions.mdx)
336345

337-
---
338-
339346
### Session
340347

341348
The `Session` is used to manipulate the data. It implements the `Unit of Work` pattern and is capable of batching the requests to save expensive remote calls. In contrast to a `DocumentStore` it is a lightweight object and can be created more frequently. For example, in web applications, a common (and recommended) pattern is to create a session per request.

0 commit comments

Comments
 (0)