cloud-native-toolkit / cloud-native-toolkit/software-everywhere

Update starter kit readmes for `oc sync`

Open
#172 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
8
Forks
8
PR merge metrics
No merged PRs in 30d

Description

All of the starter kit readme need to be updated to instruct the user to run `oc sync -p` instead of `oc sync`. Otherwise the user will *always* end up with a failed pipeline, without any indication how to fix it. Right now, none of the repo's readmes include the `-p` flag.

Readmes that need to be updated:

- https://github.com/IBM/template-node-react/blob/master/README.md
- https://github.com/IBM/template-node-typescript/blob/main/README.md
- https://github.com/IBM/template-go-gin/blob/master/README.md

Additionally, these Readmes don't include a `sync` command at all (they should).

- https://github.com/IBM/template-java-spring/blob/main/README.md
- https://github.com/IBM/template-node-angular/blob/master/README.md
- https://github.com/IBM/template-graphql-typescript/blob/main/README.md
- https://github.com/IBM/template-quarkus/blob/main/README.md
- https://github.com/IBM/template-liberty/blob/main/README.md
- https://github.com/cloud-native-toolkit/inventory-management-svc-solution
- https://github.com/cloud-native-toolkit/inventory-management-bff-solution
- https://github.com/cloud-native-toolkit/inventory-management-ui-solution

Side note: `oc sync` and `igc sync` are the same thing, and `oc pipeline` and `igc pipeline` are the same thing. They are aliases of the same command.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.