Skip to content

Commit 5d91790

Browse files
Documentation update (#1703)
- Migrated dev guide to have it here on GitHub - Updated existing docs to point to the new guide - Updated links to HERE docs portal Relates-To: DATASDK-92, DATASDK-99 Signed-off-by: Andrey Kashcheev <ext-andrey.kashcheev@here.com>
1 parent b1ce4a4 commit 5d91790

26 files changed

Lines changed: 702 additions & 34 deletions

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ HERE Data SDK for C++ is a C++ client for the <a href="https://platform.here.com
44

55
## Use the SDK
66

7-
To learn how to install and use the Data SDK, see the <a href="https://github.com/heremaps/here-data-sdk-cpp/blob/master/docs/get-started.md" target="_blank">Getting Started Guide</a> and <a href="https://www.here.com/docs/bundle/data-sdk-for-cpp-developer-guide/page/README.html" target="blank">Developer Guide</a>.
7+
To learn how to install and use the Data SDK, see the <a href="https://github.com/heremaps/here-data-sdk-cpp/blob/master/docs/get-started.md" target="_blank">Getting Started Guide</a> and <a href="https://github.com/heremaps/here-data-sdk-cpp/blob/master/docs/dev_guide/SUMMARY.md" target="blank">Developer Guide</a>.
88

99
## Health check
1010

@@ -30,13 +30,13 @@ To learn how to install and use the Data SDK, see the <a href="https://github.co
3030

3131
We try to develop and maintain our API in a way that preserves its compatibility with the existing applications. Changes in Data SDK for C++ are greatly influenced by the Data API development. Data API introduces breaking changes 6 months in advance. Therefore, you may need to migrate to a new version of Data SDK for C++ every half a year.
3232

33-
For more information on Data API, see its <a href="https://www.here.com/docs/bundle/data-api-developer-guide/page/README.html" target="_blank">Developer Guide</a> and <a href="https://www.here.com/docs/category/data-api" target="_blank">API Reference</a>.
33+
For more information on Data API, see its <a href="https://docs.here.com/data-api/docs/data-api-intro" target="_blank">Developer Guide</a> and <a href="https://docs.here.com/data-api/reference" target="_blank">API Reference</a>.
3434

3535
When new API is introduced in Data SDK for C++, the old one is not deleted straight away. The standard API deprecation time is 6 months. It gives you time to switch to new code. However, we do not provide ABI backward compatibility.
3636

37-
Learn more about deprecated methods, functions, and parameters in the Data SDK for C++ <a href="https://www.here.com/docs/bundle/data-sdk-for-cpp-api-reference/page/index.html" target="_blank">API Reference</a> and <a href="https://github.com/heremaps/here-data-sdk-cpp/blob/master/CHANGELOG.md" target="_blank">changelog</a>.
37+
Learn more about deprecated methods, functions, and parameters in the Data SDK for C++ <a href="https://heremaps.github.io/here-data-sdk-cpp/index.html" target="_blank">API Reference</a> and <a href="https://github.com/heremaps/here-data-sdk-cpp/blob/master/CHANGELOG.md" target="_blank">changelog</a>.
3838

39-
For more information on Data SDK for C++, see our <a href="https://www.here.com/docs/bundle/data-sdk-for-cpp-developer-guide/page/README.html" target="blank">Developer Guide</a>.
39+
For more information on Data SDK for C++, see our <a href="https://github.com/heremaps/here-data-sdk-cpp/blob/master/docs/dev_guide/SUMMARY.md" target="blank">Developer Guide</a>.
4040

4141
## Supported platforms
4242

docs/OverallArchitecture.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Outline
44

5-
This document describes the overall architecture of HERE Data SDK for C++ (here also referred to as SDK). For an overview of the scope and the features of the SDK, see [README.md](../README.md#why-use).
5+
This document describes the overall architecture of HERE Data SDK for C++ (here also referred to as SDK). For an overview of the scope and the features of the SDK, see [README.md](../README.md#use-the-sdk).
66

77
## Component overview
88

@@ -56,7 +56,7 @@ The dataservice-read module wraps a subset of the Data REST API related to readi
5656
* [Config API](https://www.here.com/docs/bundle/data-api-config-v1-api-reference/page/index.html)
5757
* [Metadata API](https://www.here.com/docs/bundle/data-api-metadata-v1-api-reference/page/index.html)
5858
* [Query API](https://www.here.com/docs/bundle/data-api-query-v1-api-reference/page/index.html)
59-
* [Volatile API](https://www.here.com/docs/bundle/data-api-volatile-blob-v1-api-reference/page/index.html)
59+
* [Volatile API](https://docs.here.com/data-api/reference/getvolatileblob)
6060
* Index layer (not supported yet). Used Data APIs:
6161
* [Index API](https://www.here.com/docs/bundle/data-api-index-v1-api-reference/page/index.html)
6262
* [Blob API](https://www.here.com/docs/bundle/data-api-blob-v1-api-reference/page/index.html)

docs/authenticate.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
To authenticate to the HERE platform and start working with HERE Data SDK for C++, you need to get an access token. You can receive it using a [default token provider](#authenticate-using-a-default-token-provider), [project authentication](#authenticate-using-project-authentication), or [federated credentials](#authenticate-using-federated-credentials).
44

5-
For instructions, see the [OAuth tokens](https://www.here.com/docs/bundle/identity-and-access-management-developer-guide/page/topics/dev-token.html) section in the Identity & Access Management Developer Guide.
5+
For instructions, see the [OAuth tokens](https://docs.here.com/identity-and-access-management/docs/manage-api-oauth) section in the Identity & Access Management Developer Guide.
66

77
> #### Note
88
> Keep your credentials secure and do not disclose them. Make sure that your credentials are not stored in a way that enables others to access them.
@@ -11,14 +11,14 @@ For instructions, see the [OAuth tokens](https://www.here.com/docs/bundle/identi
1111

1212
1. Get your platform credentials.
1313

14-
For instructions, see the [Register your application](https://www.here.com/docs/bundle/identity-and-access-management-developer-guide/page/topics/plat-token.html#step-1-register-your-application-and-get-credentials) section in the Identity & Access Management Developer Guide.
14+
For instructions, see the [Register your application](https://docs.here.com/identity-and-access-management/docs/plat-using-oidc#step-2---register-your-app-and-get-credentials) section in the Identity & Access Management Developer Guide.
1515

1616
You get the `credentials.properties` file.
1717

1818
2. Initialize the authentication settings using the **here.access.key.іd** and **here.access.key.secret** from the `credentials.properties` file as `kKeyId` and `kKeySecret` respectively.
1919

2020
> #### Note
21-
> You can also retrieve your credentials from the `credentials.properties` file using the `ReadFromFile` method. For more information, see the [related API documentation](https://www.here.com/docs/bundle/data-sdk-for-cpp-api-reference/page/namespaceolp_1_1authentication.html#).
21+
> You can also retrieve your credentials from the `credentials.properties` file using the `ReadFromFile` method. For more information, see the [related API documentation](https://heremaps.github.io/here-data-sdk-cpp/namespaceolp_1_1authentication.html).
2222
2323
```cpp
2424
olp::authentication::Settings settings({kKeyId, kKeySecret});
@@ -42,12 +42,12 @@ You can use the `AuthenticationSettings` object to create the `OlpClientSettings
4242

4343
1. Get your platform credentials.
4444

45-
For instructions, see the [Register your application](https://www.here.com/docs/bundle/identity-and-access-management-developer-guide/page/topics/plat-token.html#step-1-register-your-application-and-get-credentials) section in the Identity & Access Management Developer Guide.
45+
For instructions, see the [Register your application](https://docs.here.com/identity-and-access-management/docs/plat-using-oidc#step-2---register-your-app-and-get-credentials) section in the Identity & Access Management Developer Guide.
4646

4747
2. Initialize the `AuthenticationCredentials` class using the **here.access.key.іd** and **here.access.key.secret** from the `credentials.properties` file as `kKeyId` and `kKeySecret` respectively.
4848

4949
> #### Note
50-
> You can also retrieve your credentials from the `credentials.properties` file using the `ReadFromFile` method. For more information, see the [related API documentation](https://www.here.com/docs/bundle/data-sdk-for-cpp-api-reference/page/namespaceolp_1_1authentication.html#).
50+
> You can also retrieve your credentials from the `credentials.properties` file using the `ReadFromFile` method. For more information, see the [related API documentation](https://heremaps.github.io/here-data-sdk-cpp/namespaceolp_1_1authentication.html).
5151
5252
```cpp
5353
olp::authentication::AuthenticationCredentials credentials(kKeyId, kKeySecret);
@@ -88,14 +88,14 @@ You can use the `AuthenticationSettings` object to create the `OlpClientSettings
8888
8989
1. Get your platform credentials.
9090
91-
For instructions, see the [Register your application](https://www.here.com/docs/bundle/identity-and-access-management-developer-guide/page/topics/plat-token.html#step-1-register-your-application-and-get-credentials) section in the Identity & Access Management Developer Guide.
91+
For instructions, see the [Register your application](https://docs.here.com/identity-and-access-management/docs/plat-using-oidc#step-2---register-your-app-and-get-credentials) section in the Identity & Access Management Developer Guide.
9292
9393
You get the `credentials.properties` file.
9494
9595
2. Initialize the `AuthenticationCredentials` class using the **here.access.key.іd** and **here.access.key.secret** from the `credentials.properties` file as `kKeyId` and `kKeySecret` respectively.
9696
9797
> #### Note
98-
> You can also retrieve your credentials from the `credentials.properties` file using the `ReadFromFile` method. For more information, see the [related API documentation](https://www.here.com/docs/bundle/data-sdk-for-cpp-api-reference/page/namespaceolp_1_1authentication.html#).
98+
> You can also retrieve your credentials from the `credentials.properties` file using the `ReadFromFile` method. For more information, see the [related API documentation](https://heremaps.github.io/here-data-sdk-cpp/namespaceolp_1_1authentication.html).
9999
100100
```cpp
101101
olp::authentication::AuthenticationCredentials credentials(kKeyId, kKeySecret);
@@ -111,7 +111,7 @@ You can use the `AuthenticationSettings` object to create the `OlpClientSettings
111111

112112
4. Get your federated (Facebook or ArcGIS) properties.
113113

114-
You should have at least your federated access token. For the complete list of federated properties, see the [related documentation](https://www.here.com/docs/bundle/data-sdk-for-cpp-api-reference/page/structolp_1_1authentication_1_1AuthenticationClient_1_1FederatedProperties.html).
114+
You should have at least your federated access token. For the complete list of federated properties, see the [related documentation](https://heremaps.github.io/here-data-sdk-cpp/structolp_1_1authentication_1_1AuthenticationClient_1_1FederatedProperties.html).
115115

116116
5. Initialize your federated properties.
117117

docs/create-platform-client-settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ You need to create the `OlpClientSettings` object to get catalog and partition m
6767
olp::client::OlpClientSettingsFactory::CreateDefaultCache(cache_settings);
6868
```
6969
70-
To learn how to get or change cache size, see [Work with a cache](https://www.here.com/docs/bundle/data-sdk-for-cpp-developer-guide/page/topics/work-with-cache.html).
70+
To learn how to get or change cache size, see [Work with a cache](./dev_guide/topics/work-with-cache.md).
7171
7272
6. Set up the `OlpClientSettings` object, and if you want to add the expiration limit for the data that is stored in the cache, set the `default_cache_expiration` to the needed expiration time.
7373

docs/dataservice-cache-example.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ On this page, find instructions on how to build and run the cache example projec
66

77
1. On the [Apps & keys](https://platform.here.com/admin/apps) page, copy your application access key ID and access key secret.
88

9-
For instructions on how to get the access key ID and access key secret, see the [Register your application](https://www.here.com/docs/bundle/identity-and-access-management-developer-guide/page/topics/plat-token.html#step-1-register-your-application-and-get-credentials) section in the Identity & Access Management Developer Guide.
9+
For instructions on how to get the access key ID and access key secret, see the [Register your application](https://docs.here.com/identity-and-access-management/docs/plat-using-oidc#step-2---register-your-app-and-get-credentials) section in the Identity & Access Management Developer Guide.
1010

1111
2. In <a href="https://github.com/heremaps/here-data-sdk-cpp/blob/master/examples/main.cpp" target="_blank">`examples/main.cpp`</a>, replace the placeholders with your access key ID, access key secret, and Here Resource Name (HRN) of the catalog.
1212

@@ -64,9 +64,9 @@ After building and running the example project, you see the following informatio
6464

6565
## How it works
6666

67-
### <a name="get-partition-data-mutable"></a>Get data from a versioned layer with a cache
67+
### Get data from a versioned layer with a cache
6868

69-
You can get data from a [versioned layer](https://www.here.com/docs/bundle/data-api-developer-guide/page/rest/layers.html#versioned-layers) with a mutable or protected cache.
69+
You can get data from a [versioned layer](https://docs.here.com/data-api/docs/layers#versioned-layers) with a mutable or protected cache.
7070

7171
**To get data from the versioned layer with mutable cache:**
7272

docs/dataservice-read-catalog-example.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ On this page, find instructions on how to build and run the read example project
66

77
1. On the [Apps & keys](https://platform.here.com/admin/apps) page, copy your application access key ID and access key secret.
88

9-
For instructions on how to get the access key ID and access key secret, see [Register your application](https://www.here.com/docs/bundle/identity-and-access-management-developer-guide/page/topics/plat-token.html#step-1-register-your-application-and-get-credentials) section in the Identity & Access Management Developer Guide.
9+
For instructions on how to get the access key ID and access key secret, see [Register your application](https://docs.here.com/identity-and-access-management/docs/plat-using-oidc#step-2---register-your-app-and-get-credentials) section in the Identity & Access Management Developer Guide.
1010

1111
2. In <a href="https://github.com/heremaps/here-data-sdk-cpp/blob/master/examples/main.cpp" target="_blank">`examples/main.cpp`</a>, replace the placeholders with your access key ID, access key secret, and Here Resource Name (HRN) of the catalog.
1212

@@ -74,7 +74,7 @@ To integrate the Data SDK libraries in the Android example project:
7474
2. In <a href="https://github.com/heremaps/here-data-sdk-cpp/blob/master/examples/android/app/src/main/cpp/MainActivityNative.cpp.in" target="_blank">`examples/android/app/src/main/cpp/MainActivityNative.cpp.in`</a>, replace the placeholders with your application access key ID, access key secret, and catalog HRN and specify that the example should run `RunExampleRead`.
7575

7676
> #### Note
77-
> To learn how to get the access key ID and access key secret, see the [Register your application](https://www.here.com/docs/bundle/identity-and-access-management-developer-guide/page/topics/plat-token.html#step-1-register-your-application-and-get-credentials) section in the Identity & Access Management Developer Guide.
77+
> To learn how to get the access key ID and access key secret, see the [Register your application](https://docs.here.com/identity-and-access-management/docs/plat-using-oidc#step-2---register-your-app-and-get-credentials) section in the Identity & Access Management Developer Guide.
7878
7979
### Build the Data SDK on Android
8080

@@ -124,7 +124,7 @@ To integrate the Data SDK libraries in the iOS example project written in the Ob
124124
3. In <a href="https://github.com/heremaps/here-data-sdk-cpp/blob/master/examples/ios/ViewController.mm" target="_blank">`examples/ios/ViewController.mm`</a>, replace the placeholders with your application access key ID, access key secret, and catalog HRN and specify that the example should run `RunExampleRead`.
125125

126126
> #### Note
127-
> To learn how to get the access key ID and access key secret, see the [Register your application](https://www.here.com/docs/bundle/identity-and-access-management-developer-guide/page/topics/plat-token.html#step-1-register-your-application-and-get-credentials) section in the Identity & Access Management Developer Guide.
127+
> To learn how to get the access key ID and access key secret, see the [Register your application](https://docs.here.com/identity-and-access-management/docs/plat-using-oidc#step-2---register-your-app-and-get-credentials) section in the Identity & Access Management Developer Guide.
128128
129129
### Build the Data SDK on iOS
130130

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ On this page, you can find instructions on how to build and run the cache exampl
66

77
1. On the [Apps & keys](https://platform.here.com/admin/apps) page, copy your application access key ID and access key secret.
88

9-
For instructions on how to get the access key ID and access key secret, see the [Register your application](https://www.here.com/docs/bundle/identity-and-access-management-developer-guide/page/topics/plat-token.html#step-1-register-your-application-and-get-credentials) section in the Identity & Access Management Developer Guide.
9+
For instructions on how to get the access key ID and access key secret, see the [Register your application](https://docs.here.com/identity-and-access-management/docs/plat-using-oidc#step-2---register-your-app-and-get-credentials) section in the Identity & Access Management Developer Guide.
1010

1111
2. In <a href="https://github.com/heremaps/here-data-sdk-cpp/blob/master/examples/main.cpp" target="_blank">examples/main.cpp</a>, replace the placeholders with your access key ID, access key secret, and Here Resource Name (HRN) of the catalog.
1212

@@ -62,7 +62,7 @@ After building and running the example project, you see the following informatio
6262

6363
### Get data from a stream layer
6464

65-
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 it.
65+
You can read messages from a [stream layer](https://docs.here.com/data-api/docs/creating-stream-layer) if you subscribe to it.
6666

6767
**To get data from the stream layer:**
6868

0 commit comments

Comments
 (0)