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

Add the note and minor corrections in the main README.md document #60

Merged
merged 8 commits into from
Nov 12, 2018

Conversation

kazydek
Copy link

@kazydek kazydek commented Nov 7, 2018

Description

Changes proposed in this pull request:

  • Added a note about a similar document in the kyma repository and the need to update it when the examples table is changed.
  • Updated the README.md for the EC example to represent the current product name.
  • Reviewed the README.md for the EC example and introduced minor fixes.
  • Modified the EC-related diagram accordingly.

Related issue(s)
Relates to #24

README.md Outdated
@@ -19,17 +19,19 @@ The examples project provides a central repository to showcase and illustrate fe

The summary of the documentation in the `examples` repository lists all available examples organized by the feature or concept they showcase. This structure provides a quick overview and easy navigation.

>**NOTE:** The table with examples is also available under `docs` in the `kyma` repository. Whenever you update the table, modify the [Overview](https://github.com/kyma-project/kyma/blob/master/docs/kyma/docs/007-overview-examples.md) document accordingly.
Copy link

Choose a reason for hiding this comment

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

Please make it a hidden html comment that is visible only to the editors

like

Copy link
Author

@kazydek kazydek Nov 8, 2018

Choose a reason for hiding this comment

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

Done.

README.md Outdated
@@ -19,17 +19,19 @@ The examples project provides a central repository to showcase and illustrate fe

The summary of the documentation in the `examples` repository lists all available examples organized by the feature or concept they showcase. This structure provides a quick overview and easy navigation.

<!-- NOTE: The table with examples is also available in the kyma repository. Whenever you update the table, modify this Overview document accordingly: https://github.com/kyma-project/kyma/blob/master/docs/kyma/docs/007-overview-examples.md. -->
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
<!-- NOTE: The table with examples is also available in the kyma repository. Whenever you update the table, modify this Overview document accordingly: https://github.com/kyma-project/kyma/blob/master/docs/kyma/docs/007-overview-examples.md. -->
<!-- NOTE: The table with examples is also available in the `kyma` repository. Whenever you update the table, modify this Overview document accordingly: https://github.com/kyma-project/kyma/blob/master/docs/kyma/docs/007-overview-examples.md. -->

Copy link
Author

@kazydek kazydek Nov 8, 2018

Choose a reason for hiding this comment

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

Actually, I didn't add it intentionally as it is a hidden comment that does not render in a preview, thus markdown formatting is not required here.

Copy link
Author

Choose a reason for hiding this comment

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

Let's change it to "kyma" repository.

To access the UI, go to `http://localhost:3000` and authenticate in Enterprise Commerce. After you authenticate, the system redirects you back to the Web UI application.
Find the access token and the ID token issued for your application by Enterprise Commerce in the **Authentication** section. Expand **The Function** section to call the function and check the results of the operation.
To access the UI, go to `http://localhost:3000` and authenticate in SAP Commerce. After you authenticate, the system redirects you back to the Web UI application.
Find the access token and the ID token issued for your application by SAP Commerce in the **Authentication** section. Expand **The Function** section to call the Function and check the results of the operation.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Find the access token and the ID token issued for your application by SAP Commerce in the **Authentication** section. Expand **The Function** section to call the Function and check the results of the operation.
Find the access token and the ID token issued for your application by SAP Commerce in the **Authentication** section. Expand **The Function** section to call the Function and check the results of the operation.

Are you sure we capitalize Function?

Copy link
Author

Choose a reason for hiding this comment

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

My bad. I will change that.

@kazydek kazydek merged commit 68f15ab into kyma-project:master Nov 12, 2018
@kazydek kazydek deleted the issue-24 branch November 12, 2018 13:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Issues or PRs related to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants