Skip to content

Commit 6dd1dd5

Browse files
committed
Fixed broken links, modified punctuation
Modified the following files: * dataservice-write-example.md - corrected punctuation, changed "e.g." to "for example", and corrected structure of several sentences * GettingStartedGuide.md - fixed broken links, corrected structure of several sentences, and added missing punctuation Relates-to: OLPEDGE-1158 Signed-off-by: Halyna Dumych <[email protected]>
1 parent 8086fdf commit 6dd1dd5

File tree

2 files changed

+16
-15
lines changed

2 files changed

+16
-15
lines changed

docs/GettingStartedGuide.md

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

33
## Get Credentials
44

5-
Prior to any catalog or service request to the [HERE Open Location Platform](https://platform.here.com) (OLP), you must obtain authentication and authorization credentials.
5+
To create catalog or service requests to the [HERE Open Location Platform](https://platform.here.com), you need to have the OLP authentication and authorization credentials.
66

7-
The following approaches are available for authenticating to the OLP within your application:
7+
The following two authentication approaches are available within your application:
88

9-
1. Using the _platform credentials_ available from the OLP portal in combination with the HERE OLP SDK for C++ authentication library.
10-
2. Using the access key ID and access key secret in the platform credentials as described in the [Authentication and Authorization Developer's Guide](https://developer.here.com/olp/documentation/access_control/topics/introduction.html) to create your own authentication and authorization client for retrieving HERE tokens, which you can then provide to the HERE OLP SDK for C++ libraries.
9+
1. Using your **platform credentials** that are available on the platform portal by means of the HERE OLP SDK for TypeScript authentication library.
10+
2. Using the **access key ID** and **access key secret** from the platform credentials as described in the [Authentication and Authorization Developer's Guide](https://developer.here.com/olp/documentation/access_control/topics/introduction.html) to create your own authentication and authorization client for retrieving HERE tokens that you can then provide to the HERE OLP SDK for C++ libraries.
1111

12-
To obtain your platform credentials, create a new application via the [Apps and Keys](https://platform.here.com/profile/apps-and-keys) page. Then click **Create a key** to download these credentials. For more information on obtaining platform credentials, see the [Manage Apps](https://developer.here.com/olp/documentation/access-control/user-guide/topics/manage-apps.html) section of the [Teams and Permissions User Guide](https://developer.here.com/olp/documentation/access-control/user-guide/index.html).
12+
To get your platform credentials, on the [Apps and Keys](https://platform.here.com/profile/apps-and-keys) page, create a new application. Then, to download the credentials, click **Create a key**. For more information on how to get platform credentials, see the [Manage Apps](https://developer.here.com/olp/documentation/access-control/user-guide/topics/manage-apps.html) section of the [Teams and Permissions User Guide](https://developer.here.com/olp/documentation/access-control/user-guide/index.html).
1313

1414
## OLP Prerequisite Knowledge
1515

16-
The use of the HERE OLP SDK for C++ requires a basic understanding of the following concepts related to the OLP:
16+
To use the HERE Open Location Platform (OLP) SDK for C++, you need to understand the following concepts related to OLP:
1717

18-
* [OLP catalog](https://developer.here.com/olp/documentation/data-user-guide/shared_content/topics/olp/concepts/catalogs.html)
19-
* [OLP layers](https://developer.here.com/olp/documentation/data-user-guide/shared_content/topics/olp/concepts/layers.html)
20-
* [OLP partitions](https://developer.here.com/olp/documentation/data-user-guide/shared_content/topics/olp/concepts/partitions.html)
21-
* [HRN (HERE Resource Name)](https://developer.here.com/olp/documentation/data-user-guide/shared_content/topics/olp/concepts/hrn.html)
18+
* [Catalogs](https://developer.here.com/olp/documentation/data-user-guide/portal/layers/catalogs.html)
19+
* [Layers](https://developer.here.com/olp/documentation/data-user-guide/portal/layers/layers.html)
20+
* [Partitions](https://developer.here.com/olp/documentation/data-user-guide/portal/layers/partitions.html)
21+
* [HERE Resource Names (HRNs)](https://developer.here.com/olp/documentation/data-user-guide/shared_content/topics/olp/concepts/hrn.html)
2222

2323
For more information, see the [HERE OLP Data User Guide](https://developer.here.com/olp/documentation/data-user-guide/index.html).
2424

2525
## Available Components
2626

27-
The HERE OLP SDK for C++ is composed of separate libraries with their own distinct functionality. For a component overview, see the [architectural overview](OverallArchitecture.md)
27+
The HERE OLP SDK for C++ contains separate libraries, each of which has a distinct functionality. For more information about the components, see the [architectural overview](OverallArchitecture.md).
2828

2929
## HERE OLP SDK for C++ in CMake Projects
3030

docs/dataservice-write-example.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ After you provide your app access key id, secret access key, catalog, and layer
8181
8282
## Building and running on iOS
8383

84-
This example shows how to integrate and use the HERE OLP SDK for C++ for a basic iOS application,written in Objective-C language.
84+
This example shows how to integrate and use the HERE OLP SDK for C++ for a basic iOS application written in the Objective-C language.
8585

8686
### Prerequisites
8787

@@ -106,14 +106,15 @@ cmake .. -GXcode -DCMAKE_TOOLCHAIN_FILE=../cmake/toolchains/iOS.cmake -DPLATFOR
106106
107107
### Build and run the application on the device
108108

109-
Now open the generated `XCode` project:
109+
Now, open the generated `XCode` project:
110+
110111
```bash
111112
open olp-cpp-sdk.xcodeproj
112113
```
113114

114-
Select the `dataservice-write-example` from the schemes list in the `XCode` project and specify your authorization credentials for the `dataservice-write-example` target.
115+
In the `XCode`, from the schemes list, select the `dataservice-write-example` project and specify your authorization credentials for the `dataservice-write-example` target.
115116

116-
Once everything is set up correctly, build and run the example application on your device. After building and running of example is complete, you see the `Publish Successful` message in the main UI screen. If you encounter an error message, e.g. `Publish Failed`, please check the device's logs for the detailed description of the error.
117+
Once everything is set up correctly, build and run the example application on your device. When the building and running of the example are completed, on the main UI screen, you see the `Publish Successful` message. If you get an error message, for example, `Publish Failed`, check the device logs for the detailed description of the error.
117118

118119
## How it works
119120

0 commit comments

Comments
 (0)