Dev guide improvements (#1705)

Fixing guide mistakes

Relates-To: DATASDK-99

Signed-off-by: Andrey Kashcheev <ext-andrey.kashcheev@here.com>

Author: andrey-kashcheev

docs/dev_guide/README.md

@@ -8,7 +8,7 @@ The Data SDK for C++ package contains three independent modules that focus on di
 - `olp-cpp-sdk-dataservice-read` – downloads and caches data from the platform.
 - `olp-cpp-sdk-dataservice-write` – queues and uploads data to the platform layers.
 
-For more information about the modules, see the [architectural overview](https://github.com/heremaps/here-olp-sdk-cpp/blob/master/docs/OverallArchitecture.md).
+For more information about the modules, see the [architectural overview](https://github.com/heremaps/here-data-sdk-cpp/blob/master/docs/OverallArchitecture.md).
 
 HERE is committed to respecting your privacy and to complying with applicable data protection and privacy laws. For more information, see the [HERE Privacy Charter](https://www.here.com/en-gb/here-privacy-charter).
 
@@ -37,4 +37,4 @@ For more information on Data API, see its [Developer Guide](https://docs.here.co
 
 When new API is introduced in the Data SDK for C++, the old one is not deleted straight away. The standard API deprecation time is six months. It gives you time to switch to new code. However, we do not provide ABI backward compatibility. 
 
-All of the deprecated methods, functions, and parameters are documented in the Data SDK for C++ [API Reference](https://heremaps.github.io/here-data-sdk-cpp/index.html) and [changelog](https://github.com/heremaps/here-olp-sdk-cpp/blob/master/CHANGELOG.md).
+All of the deprecated methods, functions, and parameters are documented in the Data SDK for C++ [API Reference](https://heremaps.github.io/here-data-sdk-cpp/index.html) and [changelog](https://github.com/heremaps/here-data-sdk-cpp/blob/master/CHANGELOG.md).

docs/dev_guide/SUMMARY.md

@@ -13,7 +13,7 @@
     - [Get data from a versioned layer](../dataservice-read-catalog-example.md#get-data-from-a-versioned-layer)
     - [Get data from a versioned layer with a cache](../dataservice-cache-example.md#get-data-from-a-versioned-layer-with-a-cache)
     - [Get data from a volatile layer](topics/get-data-from-volatile-layer.md)
-    - [Get data from a stream layer](../dataservice-read-from-stream-layer-example.md#get-data-from-a-stream-layer)
+    - [Get data from a stream layer](topics/get-data-from-stream-layer.md)
   - [Publish data](topics/publish-data.md)
     - [Publish data to a versioned layer](topics/publish-data-to-versioned-layer.md)
     - [Publish data to a volatile layer](topics/publish-data-to-volatile-layer.md)

docs/dev_guide/topics/get-catalog-metadata.md

@@ -34,7 +34,7 @@ Catalog metadata contains a list of configurations that describe the catalog and
    request.WithBillingTag("MyBillingTag");
    ```
 
-5. Call the `GetRequest` method with the `CatalogRequest` parameter.
+5. Call the `GetCatalog` method with the `CatalogRequest` parameter.
 
    ```cpp
    auto future = catalog_client.GetCatalog(request);
@@ -44,7 +44,7 @@ Catalog metadata contains a list of configurations that describe the catalog and
 
    ```cpp
    olp::dataservice::read::CatalogResponse catalog_response = future.GetFuture().get();
-   ````
+   ```
 
 The `CatalogResponse` object holds details of the completed operation and is used to determine operation success and access resultant data:
 

docs/dev_guide/topics/get-data-from-stream-layer.md

@@ -12,8 +12,7 @@ You can read messages from a [stream layer](https://docs.here.com/data-api/docs/
 
    ```cpp
    olp::dataservice::read::StreamLayerClient client(
-        client::HRN catalog, std::string layer_id,
-        client::OlpClientSettings settings);
+       olp::client::HRN(kCatalogHRN), layer_id, client_settings);
    ```
 
 3. Create the `SubscribeRequest` object with the `serial` or `parallel` subscription type.
@@ -24,22 +23,25 @@ You can read messages from a [stream layer](https://docs.here.com/data-api/docs/
 
    ```cpp
    auto request = olp::dataservice::read::SubscribeRequest()
-                     .WithSubscriptionMode(olp::dataservice::read::SubscribeRequest::SubscriptionMode::kSerial));
+                     .WithSubscriptionMode(olp::dataservice::read::SubscribeRequest::SubscriptionMode::kSerial);
    ```
 
 4. Call the `Subscribe` method with the `SubscribeRequest` parameter.
 
    ```cpp
-   client::CancellableFuture<SubscribeResponse> Subscribe(
-      SubscribeRequest request);
+   auto future = client.Subscribe(request);
+   auto subscribe_response = future.GetFuture().get();
+   auto subscription_id = subscribe_response.GetResult();
    ```
 
    You receive a subscription ID from the requested subscription to the selected layer.
 
 5. Call the `Poll` method.
 
    ```cpp
-   client::CancellableFuture<PollResponse> Poll();
+   auto poll_future = client.Poll();
+   auto poll_response = poll_future.GetFuture().get();
+   auto messages = poll_response.GetResult().GetMessages();
    ```
 
    You get messages with the layer data and partition metadata. The `Poll` method also commits the offsets, so you can continue polling new messages.
@@ -49,8 +51,8 @@ You can read messages from a [stream layer](https://docs.here.com/data-api/docs/
 6. If the data size is greater than 1 MB, call the `GetData` method with the `Messages` instance.
 
    ```cpp
-    client::CancellableFuture<DataResponse> GetData(
-        const model::Message& message);
+    auto data_future = client.GetData(message);
+    auto data_response = data_future.GetFuture().get();
    ```
 
 You get data from the requested partition.

docs/dev_guide/topics/get-data-from-volatile-layer.md

@@ -12,7 +12,7 @@ You can only get the latest published data from a [volatile layer](https://docs.
 
    ```cpp
    olp::dataservice::read::VolatileLayerClient layer_client(
-   olp::client::HRN(kCatalogHRN), layer_id, client_settings);
+       olp::client::HRN(kCatalogHRN), layer_id, client_settings);
    ```
 
 3. Create the `DataRequest` object with the partition ID and one of the following fetch options:
@@ -29,7 +29,7 @@ You can only get the latest published data from a [volatile layer](https://docs.
                       .WithFetchOption(FetchOptions::OnlineIfNotFound);
    ```
 
-4. Call the `GetRequest` method with the `DataRequest` parameter.
+4. Call the `GetData` method with the `DataRequest` parameter.
 
    ```cpp
    auto future = layer_client.GetData(request);
@@ -39,7 +39,7 @@ You can only get the latest published data from a [volatile layer](https://docs.
 
    ```cpp
    olp::dataservice::read::DataResponse data_response =
-   future.GetFuture().get();
+       future.GetFuture().get();
    ```
 
 The `DataResponse` object holds details of the completed operation and is used to determine operation success and access resultant data:

docs/dev_guide/topics/get-data.md

@@ -1,9 +1,9 @@
 # Get data
 
-You can use the HERE Data SDK for C++ to get data from catalogs. The process of getting data from catalogs depends on the layer type. Currently, we only support getting data from versioned, volatile, and stream layers. Test.
+You can use the HERE Data SDK for C++ to get data from catalogs. The process of getting data from catalogs depends on the layer type. Currently, we only support getting data from versioned, volatile, and stream layers.
 
 - [Get data from a versioned layer](../../dataservice-read-catalog-example.md#get-data-from-a-versioned-layer)
 - [Get data from a versioned layer with a cache](../../dataservice-cache-example.md#get-data-from-a-versioned-layer-with-a-cache)
 - [Get data from a volatile layer](get-data-from-volatile-layer.md)
-- [Get data from a stream layer](../../dataservice-read-from-stream-layer-example.md#get-data-from-a-stream-layer)
+- [Get data from a stream layer](get-data-from-stream-layer.md)
 

docs/dev_guide/topics/get-partition-metadata.md

@@ -13,7 +13,7 @@ Partition metadata consists of the following information about the partition:
 
 1. Create the `OlpClientSettings` object.
 
-   For instructions, see [Create platform client settings](../docs/create-platform-client-settings.md).
+   For instructions, see [Create platform client settings](../../create-platform-client-settings.md).
 
 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.
 
@@ -43,7 +43,7 @@ Partition metadata consists of the following information about the partition:
                olp::dataservice::read::FetchOptions::OnlineIfNotFound);
    ```
 
-4. Call `GetPartitions` method with the `PartitionRequest` parameter.
+4. Call `GetPartitions` method with the `PartitionsRequest` parameter.
 
    ```cpp
    auto future = layer_client.GetPartitions(request);

docs/dev_guide/topics/manage-eviction-protection.md

@@ -39,7 +39,7 @@ You can also remove tile keys from protection.
     - If you want to remove tile keys from protection, make sure that the `Protect` method is not in progress, and then call the `Release` method with the list of tile keys that you want to remove from protection.
 
         ```cpp
-        layer_client.Protect(<vector of tile keys>);
+        layer_client.Release(<vector of tile keys>);
         ```
 
         Data and keys of the specified tiles are removed from the protected list. The keys are added to the LRU cache. Now, they can be evicted. Expiration value is restored, and keys can expire. The quadtree can be removed from the protected list if all tile keys are no longer protected.

docs/dev_guide/topics/publish-data-to-index-layer.md

@@ -35,7 +35,7 @@ You can index and store metadata and data in a way that is optimized for batch p
                                         .WithLayerId(layer_id);
    ```
 
-5. Call the `PublishIndex` method with the `DataRequest` parameter.
+5. Call the `PublishIndex` method with the `PublishIndexRequest` parameter.
 
    ```cpp
    auto future = client.PublishIndex(index_request);

docs/dev_guide/topics/publish-data-to-versioned-layer.md

@@ -61,7 +61,7 @@ If you need to store and access the history of previous data updates, publish da
 
    ```cpp
    auto complete_batch_response =
-       versioned_client->CompleteBatch(get_batch_response.GetResult())
+       versioned_client.CompleteBatch(get_batch_response.GetResult())
            .GetFuture()
            .get();
    ```
@@ -73,11 +73,11 @@ The `PublishDataResponse` object holds details of the completed operation and is
 - `GetError()` – contains error information as a result of an error in the `olp::client::ApiError` object.
 
 ```cpp
-if (response.IsSuccessful()) {
-    auto response_result = response.GetResult();
+if (complete_batch_response.IsSuccessful()) {
+    auto response_result = complete_batch_response.GetResult();
     // Handle success
 } else {
-    auto api_error = response.GetError();
+    auto api_error = complete_batch_response.GetError();
     // Handle fail
 }
 ```