Skip to content

Commit ce36787

Browse files
TW-1242: update links and touch up "Get started" (#532)
This MR fixes several issues introduced when updating links from developer.here.com to their here.com/docs counterparts. In the process, the "Get started" documentation was touched up. Resolves: TW-1242 Signed-off-by: Tom Papiernik <tomasz.papiernik@here.com>
1 parent a5f76ba commit ce36787

File tree

2 files changed

+16
-37
lines changed

2 files changed

+16
-37
lines changed

docs/GettingStartedGuide.md

Lines changed: 8 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,15 @@
11
# Get started
22

3-
HERE Data SDK for TypeScript includes the core components to access the HERE APIs from any web-based application.
4-
5-
In this guide, learn how to authenticate to and start working with the HERE platform using the Data SDK:
6-
7-
- [Prerequisites](#prerequisites)
8-
- [Concepts](#concepts)
9-
- [Get credentials](#get-credentials)
10-
- [Installation](#installation)
11-
- [Development](#development)
12-
- [Dependencies](#dependencies)
13-
- [Download dependencies](#download-dependencies)
14-
- [Build the SDK](#build-the-sdk)
15-
- [Test the SDK](#test-the-sdk)
16-
- [Test coverage](#test-coverage)
17-
- [Generate documentation with TypeDoc](#generate-documentation-with-typedoc)
18-
- [Use the bundle functionality](#use-the-bundle-functionality)
19-
- [Available components](#available-components)
20-
- [Reference documentation](#reference-documentation)
21-
- [Examples](#examples)
3+
HERE Data SDK for TypeScript includes the core components to access HERE APIs from any web-based application.
4+
Read this topic to learn how to authenticate to and start working with the HERE platform using the HERE Data SDK for TypeScript.
225

236
## Prerequisites
247

25-
To start using Data SDK for TypeScript, you need a platform user account.
8+
- HERE platform account. Follow [this link](https://platform.here.com/portal/sign-up) to create an account.
9+
- Basic understanding of the core HERE platform concepts.
10+
- Basic TypeScript proficiency.
2611

27-
Working with the Data SDK requires knowledge of the following subjects:
28-
29-
- Basic understanding of the core [HERE platform concepts](#concepts).
30-
- Basic proficiency with TypeScript.
31-
32-
## Concepts
12+
### Concepts
3313

3414
To use Data SDK for TypeScript, you need to understand the following concepts related to the HERE platform:
3515

@@ -38,8 +18,6 @@ To use Data SDK for TypeScript, you need to understand the following concepts re
3818
* [Partitions](https://www.here.com/docs/bundle/data-api-developer-guide/page/rest/partitions.html)
3919
* [HERE Resource Names (HRNs)](https://www.here.com/docs/bundle/data-api-developer-guide/page/rest/hrn.html)
4020

41-
For more details, see the [Data User Guide](https://www.here.com/docs/bundle/data-api-developer-guide/page/README.html).
42-
4321
## Get credentials
4422

4523
To work with catalog or service requests to the HERE platform, you need to get authentication and authorization credentials.
@@ -84,7 +62,8 @@ Data SDK for TypeScript has the following dependencies:
8462
- npm 10+ (for installation instructions, see <a href="https://www.npmjs.com/" target="_blank">npm</a>)
8563
- Node.js 18+ (for installation instructions, see <a href="http://nodejs.org" target="_blank">Node.js</a>)
8664

87-
> **Note:** As an alternative to npm, you can also use Yarn 1+ (for installation instructions, see <a href="http://yarnpkg.com" target="_blank">Yarn</a>).
65+
> #### Note
66+
> As an alternative to npm, you can use Yarn. For installation instructions, see [Yarn documentation](https://yarnpkg.com/getting-started/install).
8867
8968
#### Download dependencies
9069

docs/read-from-stream-layer.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This example shows how to read partition metadata and partition data from a stre
44

55
## Build and run an app on Node.js
66

7-
Before you build an app, make sure that you installed all of the <a href="https://github.com/heremaps/here-data-sdk-typescript#dependencies" target="_blank">dependencies</a>.
7+
Before you build an app, make sure that you installed all of the [dependencies](GettingStartedGuide.md#dependencies).
88

99
**To build and run an app on Node.js:**
1010

@@ -65,7 +65,7 @@ App works!
6565

6666
## Create `StreamLayerClient`
6767

68-
You can use the `StreamLayerClient` class to request data from the queue that streams data from a [stream layer](https://www.here.com/docs/bundle/data-api-developer-guide/page/README.html#stream-layers). Once a consumer reads the data, the data is no longer available to that consumer, but the data remains available to other consumers.
68+
You can use the `StreamLayerClient` class to request data from the queue that streams data from a [stream layer](https://www.here.com/docs/bundle/data-api-developer-guide/page/rest/layers.html#stream-layers). Once a consumer reads the data, the data is no longer available to that consumer, but the data remains available to other consumers.
6969

7070
Stream layers can be configured with retention time, or time-to-live (TTL) which results in unconsumed data being removed after a specified period.
7171

@@ -119,9 +119,9 @@ Stream layers can be configured with retention time, or time-to-live (TTL) which
119119

120120
Now, to get data, you can call the `Poll` method.
121121

122-
## <a name="get-data-streamlayerclient"></a>Get data and partition metadata from a stream layer
122+
## Get data and partition metadata from a stream layer
123123

124-
You can read messages from a [stream layer](https://www.here.com/docs/bundle/data-api-developer-guide/page/README.html#stream-layers) if you subscribe to the layer. The messages contain data and the following partition metadata:
124+
You can read messages from a [stream layer](https://www.here.com/docs/bundle/data-api-developer-guide/page/rest/layers.html#stream-layers) if you subscribe to the layer. The messages contain data and the following partition metadata:
125125

126126
- Data handle
127127
- ID
@@ -134,9 +134,9 @@ You can read messages from a [stream layer](https://www.here.com/docs/bundle/dat
134134

135135
1. Create the `streamLayerClient` object.
136136

137-
For instructions, see [Create StreamLayerClient]([#create-streamlayerclient](https://www.here.com/docs/bundle/data-api-developer-guide/page/rest/layer-creating_2.html)).
137+
For instructions, see [Create StreamLayerClient](#create-streamlayerclient).
138138

139-
2. Subscribe to the stream layer. See [Subscribe to the stream layer](https://www.here.com/docs/bundle/data-api-developer-guide/page/rest/getting-data-stream.html)
139+
2. Subscribe to the stream layer.
140140

141141
3. Call the `poll` method with the subscription ID.
142142

@@ -197,7 +197,7 @@ You can read messages from a [stream layer](https://www.here.com/docs/bundle/dat
197197

198198
You get data from the requested partition.
199199

200-
## <a name="seek-streamlayerclient"></a>Seek to a predefined offset
200+
## Seek to a predefined offset
201201

202202
You can start reading data from a specified offset. To start message consumption from a layer (topic) offset, move the message pointer to it. Once you seek to an offset, you cannot return to the initial offset, unless the initial offset is saved.
203203

@@ -210,7 +210,7 @@ await streamLayerClient.seek(
210210
);
211211
```
212212

213-
## <a name="unsubscribe-streamlayerclient"></a>Delete a subscription to a layer
213+
## Delete a subscription to a layer
214214

215215
You can delete a subscription to a layer (topic). This operation removes the subscription from the service.
216216

0 commit comments

Comments
 (0)