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

Documentation suggestions for cp-web instructions #54

Open
ptippett opened this issue Nov 11, 2016 · 0 comments
Open

Documentation suggestions for cp-web instructions #54

ptippett opened this issue Nov 11, 2016 · 0 comments

Comments

@ptippett
Copy link

Comments below reference each step of the cp-web instructions. So my comment 1 applies to step 1, etc.

  1. link to git instructions and give the exact command for cloning the repo. Git instructions should probably also reference full git instructions for more info. Especially since they have to clone a branch
    which isn't obvious.

It occurred to me after going through this that one option might be to have them run the marbles demo first, then move to this one since that would cover all their setup and is a somewhat simpler example.

  1. Help them set up a network in bluemix, should reference what was done for marbles.
  2. More help here, where do I get the credentials? screenshots. Again this is explained in marbles doc so could link there. If you had them do marbles first, could just copy that creds file.
  3. make sure the key/value store only has values for your network. mycreds.json is a key value store, but should make it clear that the key value store you're talking about is
    mycreds.json. Again, copy info from marbles.
  4. give an example, simply showing a // in front of the line.
    6./7. These assume you completed setup, which maybe they have not. Again reference the info from marbles.

Starting the application:

Need to make sure c:\tmp exists on windows, otherwise startup will fail. Probably want this to point to a non %temp% location so it won't get wiped on restart since if they lose their webadmin cert they'll need to redo everything.

Need to give them the URLs to use directly http://localhost:3000/login (:3000 will redirect to login).

IMO should remove the 1.0 branch now that the new service is deployed to prevent confusion and errors when trying to use new app on old network or vice versa.

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

No branches or pull requests

1 participant