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

Add documentation for Deploying to Heroku to README #986

Merged
merged 3 commits into from
Aug 20, 2019

Conversation

lpender
Copy link
Contributor

@lpender lpender commented Jul 30, 2019

I think that the process of deploying to Heroku has created enough confusion and frustration that it's time to add a simple summary of the setup required to the documentation about it. This should be updated and expanded or contracted when new issues arise or are resolved.

@StevenXL
Copy link

@lpender thank you for submitting this PR. I hope it gets merged soon. It was very helpful for me - i found it a little late but my build kept failing as I had the APPLICATION_HOST set incorrectly.

Copy link
Contributor

@composerinteralia composerinteralia left a comment

Choose a reason for hiding this comment

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

Ideally we will get this to a place where we can run suspenders my_app, and then deploying to Heroku just works, but having some additional documentation in the meantime makes sense to me. Thanks!

See also #930

README.md Outdated
@@ -117,6 +117,8 @@ Suspenders also comes with:

## Heroku

Read the documentation on [deploying to Heroku](heroku deploy)
Copy link
Contributor

Choose a reason for hiding this comment

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

Broken Link:

Suggested change
Read the documentation on [deploying to Heroku](heroku deploy)
Read the documentation on [deploying to Heroku][heroku deploy]

Copy link
Contributor

@composerinteralia composerinteralia Aug 20, 2019

Choose a reason for hiding this comment

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

Now I am getting a 404 for the link. It may be easier to put the text inline into the README

Copy link
Contributor Author

@lpender lpender Aug 20, 2019

Choose a reason for hiding this comment

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

Hey, apologies. I think there are two issues:

  1. The link was wrong (didn't contain /blob/master/)
  2. The link won't work until this is merged to master

See for reference:

i.e.

Works:

https://github.com/thoughtbot/suspenders/blob/master/README.md

Doesn't Work (yet)

https://github.com/thoughtbot/suspenders/blob/master/docs/heroku_deploy.md

Sorry for the confusion

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks!

Co-Authored-By: Daniel Colson <[email protected]>
README.md Outdated Show resolved Hide resolved
@composerinteralia composerinteralia merged commit f18d904 into thoughtbot:master Aug 20, 2019
@lpender lpender deleted the lp-deploy-to-heroku-docs branch September 5, 2019 13:53
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.

3 participants