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

Cleaned up documentation for initial setup for developer tasks. #1022

Merged
merged 1 commit into from
May 11, 2020

Conversation

iennae
Copy link
Contributor

@iennae iennae commented May 1, 2020

What does this change

In the initial setup, I was getting an error following

go get -u  get.porter.sh/porter
package get.porter.sh/porter: no Go files in /Users/sigje/go/src/get.porter.sh/porter

This commit cleans up the documentation around initial setup to match what I think
is going on more closely.

What issue does it fix

Closes #1020

Notes for the reviewer

A couple of issues to think about:

  • get.porter.sh url versus GitHub
  • meta around what install does and whether more process documentation is needed around setup.

I'm not sure whether there is a get.porter.sh url that would work for cloning directly.

This

fatal: unable to update url base from redirection:
  asked for: https://get.porter.sh/porter/info/refs?service=git-upload-pack
   redirect: https://github.com/deislabs/porter

didn't work and maybe there is a better way to do that or maybe it's just a "remember to update when the organization changes".

Additionally, I did clean up the language in the what does make install do. I'm kind of wondering if there is a need to say something around creating a development environment separate from operating environment.

Say you've installed porter following that process, decide you want to do some development work, if you follow the steps as written you just blew away your installation for the development version. That's probably a separate meta/docs issue, but I wanted to bring it up.

Checklist

  • Unit Tests
  • Documentation
  • Schema (porter.yaml)

In the initial setup, I was getting an error following

```
go get -u  get.porter.sh/porter
package get.porter.sh/porter: no Go files in /Users/sigje/go/src/get.porter.sh/porter
```

This commit cleans up the documentation around initial setup to match what I think
is going on more closely.

Signed-off-by: Jennifer Davis <[email protected]>
@iennae
Copy link
Contributor Author

iennae commented May 4, 2020

set PORTER_HOME and modify how they call from so folks don't have to install and override system installed porter.
Example:


$ export PORTER_HOME=~/.porter
$ ./bin/porter list
NAME                     CREATED      MODIFIED     LAST ACTION   LAST STATUS
porter-wordpress         2019-11-11   2019-11-11   install       success
porter-wordpress-mysql   2019-11-11   2019-11-11   install       success

Copy link
Member

@vdice vdice left a comment

Choose a reason for hiding this comment

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

LGTM!

@vdice vdice merged commit 8f081af into getporter:master May 11, 2020
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

Successfully merging this pull request may close these issues.

Update documentation to clear up contributing steps
2 participants