Skip to content
This repository has been archived by the owner on Dec 24, 2021. It is now read-only.

Suggestions to help improve README.md #80

Open
madisongong opened this issue Jul 18, 2018 · 0 comments
Open

Suggestions to help improve README.md #80

madisongong opened this issue Jul 18, 2018 · 0 comments

Comments

@madisongong
Copy link

Hello! My name is Madison and I'm one of the IBM Digital Business Group San Francisco interns this summer. I'm currently going through some IBM code patterns and documenting my experiences to hopefully provide some useful suggestions to help improve the code patterns' user instructions. As a beginner coder, I hope I'll be able to bring a fresh pair of eyes to these patterns and provide some feedback on how to perhaps clarify some steps to make them more clear to other beginner developers who are new to code patterns and the topics these code patterns cover in general.

Steps
Suggestions:

  • I went through both the "Deploy to IBM Cloud" button and creating the services & run locally options, but when I was first starting this code pattern, I was confused about the difference between them and which one I should personally do. It may be helpful for users to be able to read an explanation of each option so they can better decide which one to do or to start out with.

  • Providing definitions for these two options can also be applied to all code patterns containing deploy to IBM cloud and running locally instructions.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant