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.

Sign up for GitHub

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

Jump to bottom

Improve the overall SC documentation #2145

Closed
8 tasks done
klaudiagrz opened this issue Dec 31, 2018 · 0 comments
Closed
8 tasks done

Improve the overall SC documentation #2145

klaudiagrz opened this issue Dec 31, 2018 · 0 comments
Assignees
@klaudiagrz
Labels
area/documentation Issues or PRs related to documentation area/service-management Issues or PRs related to service management kind/feature Categorizes issue or PR as related to a new feature.

Comments

@klaudiagrz
Copy link
Contributor

klaudiagrz commented Dec 31, 2018 •
edited
Loading

Description

When going through the SC documentation, there are some bugs and inconsistencies that make the documentation unapproachable and hard to read.

Improve the UX by fixing the following issues:

  • Fix the punctuation in the Resources document (double dot at the end).
  • Add the GCP Broker to the list of supported brokers.
  • In the Add a service to the Catalog document, link to the getting started guide, not to the ServiceBrokers Overview.
  • Change the order of the sections in the Provisioning and binding document to make it end-to-end story.
  • Change the Bind with other resources section into Define other types of application.
  • Rename Etcd Database section into Service Catalog Backup and Restore.
  • Paraphrase the introduction of the Etcd Database document as discussed.
  • Go through all the SC documentation once again to make sure it is consistent and approachable.
@klaudiagrz klaudiagrz added this to the Backlog_Gopher milestone Dec 31, 2018
@klaudiagrz klaudiagrz self-assigned this Dec 31, 2018
@klaudiagrz klaudiagrz added area/documentation Issues or PRs related to documentation kind/feature Categorizes issue or PR as related to a new feature. area/service-management Issues or PRs related to service management labels Dec 31, 2018
@PK85 PK85 modified the milestones: Backlog_Gopher, Sprint_Gopher_8 Jan 3, 2019
@klaudiagrz klaudiagrz mentioned this issue Jan 9, 2019
Merged
grischperl pushed a commit to grischperl/kyma that referenced this issue Nov 10, 2020
@parostatkiem-zz
Display "Copying license..." message only if --verbose flag is set (k…
3387594 
…yma-project#2145)

* Display "Copying..." message only if VERBOSE flag is set to true

* add --verbose arg
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@klaudiagrz klaudiagrz

Labels
area/documentation Issues or PRs related to documentation area/service-management Issues or PRs related to service management kind/feature Categorizes issue or PR as related to a new feature.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@mjasinski5 @PK85 @klaudiagrz