Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[readme] Add api documentation link #203

Merged
merged 1 commit into from
Jul 19, 2018
Merged

Conversation

felixsch
Copy link
Contributor

No description provided.

@suse-tests-pass
Copy link
Collaborator

suse-tests-pass commented Jul 17, 2018

1 Warning
⚠️ Unless this is a trivial change, please include a CHANGELOG entry.
Run osc vc in the package directory to add one.

Generated by 🚫 Danger

README.md Outdated
@@ -159,6 +159,10 @@ RMT is replacing some functionality of [SMT](https://github.com/SUSE/smt). Follo
<a name="staging">1</a>: Functionality is offered by [SUSE Manager](https://www.suse.com/documentation/suse-best-practices/susemanager/data/susemanager.html)
<a name="res">2</a>: RES support is planned for SLES15 SP1

## API documentation

The documentation about the implemented SCC API can be found [here](https://github.com/SUSE/connect/blob/master/doc/SCC-API-(Implemented).md).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could it say something like RMT partially implements [SUSE Customer Center API](link)?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure

README.md Outdated
@@ -159,6 +159,10 @@ RMT is replacing some functionality of [SMT](https://github.com/SUSE/smt). Follo
<a name="staging">1</a>: Functionality is offered by [SUSE Manager](https://www.suse.com/documentation/suse-best-practices/susemanager/data/susemanager.html)
<a name="res">2</a>: RES support is planned for SLES15 SP1

## API documentation

RMT partially implements the [SUSE Customer API](https://github.com/SUSE/connect/blob/master/doc/SCC-API-(Implemented).md). Make sure to checkout the `Differences in RMT, SMT and SCC API` to check which API endpoints are not supported by RMT.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SUSE Customer API -> SUSE Customer Center API 😬

Copy link
Contributor

@ikapelyukhin ikapelyukhin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

README.md Outdated
@@ -159,6 +159,10 @@ RMT is replacing some functionality of [SMT](https://github.com/SUSE/smt). Follo
<a name="staging">1</a>: Functionality is offered by [SUSE Manager](https://www.suse.com/documentation/suse-best-practices/susemanager/data/susemanager.html)
<a name="res">2</a>: RES support is planned for SLES15 SP1

## API documentation

RMT partially implements the [SUSE Customer Center API](https://github.com/SUSE/connect/blob/master/doc/SCC-API-(Implemented).md). Make sure to checkout the `Differences in RMT, SMT and SCC API` to check which API endpoints are not supported by RMT.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You could just link Differences in RMT, SMT and SCC API right to the paragraph with https://github.com/SUSE/connect/blob/master/doc/SCC-API-(Implemented).md#differences-in-rmt-smt-and-scc-api.

@felixsch felixsch merged commit 0b1ea37 into master Jul 19, 2018
@ikapelyukhin ikapelyukhin deleted the add-connect-api-link branch September 10, 2018 10:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants