Skip to content

Commit 597c930

Browse files
authored
Minor doc updates (#1112)
- Modify several links. - Change the following heading: "Get partition data from a versioned layer" to "Get partition data from a versioned layer". Relates-To: OLPEDGE-2348 Signed-off-by: Halyna Dumych <[email protected]>
1 parent 452006b commit 597c930

7 files changed

+13
-13
lines changed

docs/GettingStartedGuide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ To start using HERE Data SDK for C++, you need a platform user account.
66

77
Working with the Data SDK requires knowledge of the following subjects:
88

9-
- Basic understanding of the core [HERE platform concepts](#concepts)
10-
- Basic proficiency with C++11 and CMake
9+
- Basic understanding of the core [HERE platform concepts](#concepts).
10+
- Basic proficiency with C++11 and CMake.
1111

1212
## Concepts
1313

docs/authenticate.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ To authenticate to the HERE platform and start working with HERE Data SDK for C+
3434

3535
You get an access token.
3636

37-
You can use the `AuthenticationSettings` object to create the `OlpClientSettings` object. For more information, see the <a href="https://github.com/heremaps/here-data-sdk-cpp/blob/master/docs/create-platform-client-settings.md" target="_blank">related section</a> in the Developer Guide.
37+
You can use the `AuthenticationSettings` object to create the `OlpClientSettings` object. For more information, see the [related section](create-platform-client-settings.md) in the Developer Guide.
3838

3939
## Authenticate using project authentication
4040

@@ -77,7 +77,7 @@ You can use the `AuthenticationSettings` object to create the `OlpClientSettings
7777

7878
You get an access token.
7979

80-
You can use the `AuthenticationSettings` object to create the `OlpClientSettings` object. For more information, see the <a href="https://github.com/heremaps/here-data-sdk-cpp/blob/master/docs/create-platform-client-settings.md" target="_blank">related section</a> in the Developer Guide.
80+
You can use the `AuthenticationSettings` object to create the `OlpClientSettings` object. For more information, see the [related section](create-platform-client-settings.md) in the Developer Guide.
8181

8282
## Authenticate using federated credentials
8383

@@ -146,4 +146,4 @@ You can use the `AuthenticationSettings` object to create the `OlpClientSettings
146146
147147
You get an access token. By default, it expires in 24 hours. To continue working with the HERE platform after your token expires, generate a new access token.
148148
149-
You can use the `AuthenticationSettings` object to create the `OlpClientSettings` object. For more information, see the <a href="https://github.com/heremaps/here-data-sdk-cpp/blob/master/docs/create-platform-client-settings.md" target="_blank">related section</a> in the Developer Guide.
149+
You can use the `AuthenticationSettings` object to create the `OlpClientSettings` object. For more information, see the [related section](create-platform-client-settings.md) in the Developer Guide.

docs/create-platform-client-settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ You need to create the `OlpClientSettings` object to get catalog and partition m
2121
> #### Note
2222
> The `Network` client is designed and intended to be shared.
2323
24-
3. <a href="https://github.com/heremaps/here-data-sdk-cpp/blob/master/docs/authenticate.md" target="_blank">Authenticate</a> to the HERE platform.
24+
3. [Authenticate](authenticate.md) to the HERE platform.
2525

2626
4. (Optional) For data that is stored in the cache, to add expiration limit, set the `default_cache_expiration` to the needed expiration time.
2727

docs/dataservice-cache-example.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ You can get data from a [versioned layer](https://developer.here.com/olp/documen
7070

7171
1. Create the `OlpClientSettings` object with the path to the needed cache settings properties (disk space, runtime memory limit, maximum file size, in-memory data cache size, options, and paths).
7272

73-
For instructions, see <a href="https://github.com/heremaps/here-data-sdk-cpp/blob/master/docs/create-platform-client-settings.md" target="_blank">Create platform client settings</a>.
73+
For instructions, see [Create platform client settings](create-platform-client-settings.md).
7474

7575
> #### Note
7676
> Perform the first call with the valid mutable cache path, and the second call – with the protected cache path.

docs/dataservice-read-catalog-example.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ Catalog metadata contains a list of configurations that describe the catalog and
187187

188188
1. Create the `OlpClientSettings` object.
189189

190-
For instructions, see <a href="https://github.com/heremaps/here-data-sdk-cpp/blob/master/docs/create-platform-client-settings.md" target="_blank">Create platform client settings</a>.
190+
For instructions, see [Create platform client settings](create-platform-client-settings.md).
191191

192192
2. Create the `CatalogClient` object with the catalog HRN and platform client settings from step 1.
193193

@@ -276,7 +276,7 @@ Partition metadata consists of the following information about the partition:
276276

277277
1. Create the `OlpClientSettings` object.
278278

279-
For instructions, see <a href="https://github.com/heremaps/here-data-sdk-cpp/blob/master/docs/create-platform-client-settings.md" target="_blank">Create platform client settings</a>.
279+
For instructions, see [Create platform client settings](create-platform-client-settings.md).
280280

281281
2. Depending on the layer type, create a versioned or volatile layer client with the HERE Resource Name (HRN), layer ID, layer version, and platform client settings from step 1.
282282

@@ -348,15 +348,15 @@ The `Partition` class contains partition metadata and exposes the following memb
348348
- `GetPartition` – returns the partition ID.
349349
- `GetVersion` – returns the latest catalog version for the partition.
350350

351-
### Get partition data from a versioned layer
351+
### Get data from a versioned layer
352352

353353
You can request any data version from a [versioned layer](https://developer.here.com/olp/documentation/data-user-guide/portal/layers/layers.html#versioned-layers). When you request a particular version of data from the versioned layer, the partition you receive in the response may have a lower version number than you requested. The version of a layer or partition represents the catalog version in which the layer or partition was last updated.
354354

355355
**To get data from the versioned layer:**
356356

357357
1. Create the `OlpClientSettings` object.
358358

359-
For instructions, see <a href="https://github.com/heremaps/here-data-sdk-cpp/blob/master/docs/create-platform-client-settings.md" target="_blank">Create platform client settings</a>.
359+
For instructions, see [Create platform client settings](create-platform-client-settings.md).
360360

361361
2. Create the `VersionedLayerClient` object with the HERE Resource Name (HRN) of the catalog that contains the layer, the layer ID, catalog version, and the platform client settings from step 1.
362362

docs/dataservice-read-from-stream-layer-example.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ You can read messages from a [stream layer](https://developer.here.com/olp/docum
6868

6969
1. Create the `OlpClientSettings` object.
7070

71-
For instructions, see <a href="https://github.com/heremaps/here-data-sdk-cpp/blob/master/docs/create-platform-client-settings.md" target="_blank">Create platform client settings</a>.
71+
For instructions, see [Create platform client settings](create-platform-client-settings.md).
7272

7373
2. Create the `StreamLayerClient` object with the HERE Resource Name (HRN) of the catalog that contains the layer, layer ID, and platform client settings from step 1.
7474

docs/dataservice-write-example.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ You can create a queue that streams data to data consumers in real time using a
174174

175175
1. Create the `OlpClientSettings` object.
176176

177-
For instructions, see <a href="https://github.com/heremaps/here-data-sdk-cpp/blob/master/docs/create-platform-client-settings.md" target="_blank">Create platform client settings</a>.
177+
For instructions, see [Create platform client settings](create-platform-client-settings.md).
178178

179179
2. Create the `StreamLayerClientSettings` object.
180180

0 commit comments

Comments
 (0)