Skip to content

Commit 0db99af

Browse files
harald-tsysharald-tsys
committed
docu adaptions
1 parent 87e1383 commit 0db99af

File tree

4 files changed

+27
-70
lines changed

4 files changed

+27
-70
lines changed

‎README.md‎

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

33
This is the community version of OTC Java SDK v1.
44

5-
>[!WARNING]
6-
> ###################################################################
7-
> Work in progress, subject to change!
8-
> ###################################################################
5+
It provides functionalities for *Access Key* and *Secret Access Key* (AK/SK) request signing used in API calls.
6+
97

108
## Documentation
119

@@ -21,3 +19,11 @@ This is the community version of OTC Java SDK v1.
2119
> ```
2220
> Open documentation in browser: <http://127.0.0.1:8889>
2321
22+
23+
## Warranty Disclaimer
24+
25+
THE OPEN SOURCE SOFTWARE IN THIS PRODUCT IS DISTRIBUTED IN THE HOPE THAT IT
26+
WILL BE USEFUL,BUT WITHOUT ANY WARRANTY; WITHOUT EVEN THE IMPLIED WARRANTY
27+
OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
28+
29+
SEE THE APPLICABLE LICENSES FOR MORE DETAILS.

‎doc/source/gettingstarted/index.rst‎

Lines changed: 12 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -28,70 +28,24 @@ These libraries are available through:
2828
# run maven clean install
2929
mvn clean install
3030
31-
.. tab:: GitHub and Maven
3231
33-
To use GitHub maven repository modify your ``settings.xml`` (e.g. ~/.m2/settings.xml) as follows.
34-
35-
If you need to use a proxy for internet connections, see `Configuring a proxy <https://maven.apache.org/guides/mini/guide-proxies.html>`_.
36-
37-
The environment variable ``GITHUB_TOKEN`` has to be set with your `GitHub personal access token <https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry#authenticating-with-a-personal-access-token>`_,
38-
e.g. in your ``~/.profile``.
32+
.. tab:: Maven Central
3933

40-
Detailed instructions can be found `Working with the Apache Maven registry: Installing a package <https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry#installing-a-package>`_
34+
Add following dependencies to your pom:
4135

4236
.. code-block:: xml
43-
:caption: settings.xml
44-
45-
<servers>
46-
<server>
47-
<id>github.opentelekomcloud-community</id>
48-
<configuration>
49-
<httpHeaders>
50-
<property>
51-
<name>Authorization</name>
52-
<value>Bearer ${env.GITHUB_TOKEN}</value>
53-
</property>
54-
</httpHeaders>
55-
</configuration>
56-
</servers>
57-
58-
<profiles>
59-
<profile>
60-
<id>default</id>
61-
62-
<repositories>
63-
<repository>
64-
<id>central</id>
65-
<url>https://repo1.maven.org/maven2</url>
66-
</repository>
67-
68-
<repository>
69-
<id>github.opentelekomcloud-community</id>
70-
<url>https://maven.pkg.github.com/opentelekomcloud-community/otc-java-sdk-v1</url>
71-
72-
<releases>
73-
<enabled>true</enabled>
74-
<updatePolicy>daily</updatePolicy>
75-
</releases>
76-
77-
<snapshots>
78-
<enabled>true</enabled>
79-
<updatePolicy>always</updatePolicy>
80-
</snapshots>
81-
82-
</repository>
83-
</repositories>
84-
</profile>
85-
</profiles>
86-
87-
<activeProfiles>
88-
<activeProfile>default</activeProfile>
89-
</activeProfiles>
90-
37+
:substitutions:
9138
92-
.. tab:: Maven Central
39+
<dependencies>
40+
...
41+
<dependency>
42+
<groupId>io.github.opentelekomcloud-community</groupId>
43+
<artifactId>otc-sdk-v1-core</artifactId>
44+
<version>|pom_version|</version>
45+
</dependency>
46+
...
47+
</dependencies>
9348
94-
Comming soon ...
9549
9650
9751
API Usage

‎doc/source/index.rst‎

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
OTC Java SDK v1 documentation
22
=============================
33

4-
The `OTC Java SDK v1` provides functionality to use OpenTelekomCloud API in Java.
4+
The `OTC Java SDK v1` provides functionality to use
5+
OpenTelekomCloud API in Java.
56

67
Escpecially methods for signing requests using AK/SK
78

@@ -21,13 +22,6 @@ For source code, see :github_repo_master:`OTC Java SDK v1 on Github <>`.
2122
Disclaimer
2223
----------
2324

24-
OPEN SOURCE SOFTWARE NOTICE
25-
^^^^^^^^^^^^^^^^^^^^^^^^^^^
26-
This document contains open source software notice for this product.
27-
And this document is confidential information of copyright holder.
28-
Recipient shall protect it in due care and shall not disseminate it
29-
without permission.
30-
3125
Warranty Disclaimer
3226
^^^^^^^^^^^^^^^^^^^^^^^^^^^
3327
THE OPEN SOURCE SOFTWARE IN THIS PRODUCT IS DISTRIBUTED IN THE HOPE THAT IT

‎samples/README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Samples
2+
3+
Folder contains samples on how to use this library.

0 commit comments

Comments
 (0)