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

[#220] Add deployment guide for Heroku #651

Merged
merged 33 commits into from
Oct 7, 2020

Conversation

mwbrooks
Copy link
Member

@mwbrooks mwbrooks commented Sep 29, 2020

Summary

This pull request is part of the on-going work related to #220. After reviewing, we will want to squash this merge.

This pull request adds the following:

  • Updates side bar with a "Deploying" section
  • Adds a "Deploying to Heroku" guide
  • Adds a "Getting Started with Heroku" example app to bolt-js/examples/

Remaining tasks before merging:

After merging, we will want to:

  • Translate the side bar for the Japanese documentation
  • Translate the guide for the Japanese documentation

Preview

https://mwbrooks.github.io/bolt-js/deployments/heroku

Requirements (place an x in each [ ])

@mwbrooks mwbrooks added the docs M-T: Documentation work only label Sep 29, 2020
@mwbrooks mwbrooks self-assigned this Sep 29, 2020
@codecov
Copy link

codecov bot commented Sep 29, 2020

Codecov Report

❗ No coverage uploaded for pull request base (main@7ecf59c). Click here to learn what that means.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #651   +/-   ##
=======================================
  Coverage        ?   84.41%           
=======================================
  Files           ?        8           
  Lines           ?      693           
  Branches        ?      206           
=======================================
  Hits            ?      585           
  Misses          ?       71           
  Partials        ?       37           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7ecf59c...bb88411. Read the comment docs.

docs/_config.yml Outdated Show resolved Hide resolved
docs/_deploying/heroku.md Outdated Show resolved Hide resolved
docs/_deploying/heroku.md Outdated Show resolved Hide resolved
docs/_deploying/heroku.md Outdated Show resolved Hide resolved
docs/_deploying/heroku.md Outdated Show resolved Hide resolved
docs/_deploying/heroku.md Outdated Show resolved Hide resolved
docs/_deploying/heroku.md Outdated Show resolved Hide resolved
docs/_deploying/heroku.md Outdated Show resolved Hide resolved
Comment on lines 217 to 223
First, select **Interativity & Shortcuts** from the side and update the **Request URL**:

![Interactivity & Shortcuts page](../assets/interactivity-and-shortcuts-page.png "Interactivity & Shortcuts page")

Second, select **Event Subscriptions** from the side and update the **Request URL**:

![Event Subscriptions page](../assets/event-subscriptions-page.png "Event Subscriptions page")
Copy link
Member Author

Choose a reason for hiding this comment

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

@shaydewael I added two images to help explain where to update the Request URL in the app management page. I know you're thinking about improving the images in the Getting Started guide. I don't want these images to step on the toes of your work, so let me know if there's a better approach that you have in mind.

Copy link
Member

@seratch seratch left a comment

Choose a reason for hiding this comment

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

This is already a great guide 👍

docs/_deploying/heroku.md Outdated Show resolved Hide resolved
docs/_deploying/heroku.md Outdated Show resolved Hide resolved
docs/_deploying/heroku.md Outdated Show resolved Hide resolved
docs/_deploying/heroku.md Outdated Show resolved Hide resolved
docs/_config.yml Outdated Show resolved Hide resolved
@@ -63,6 +60,18 @@
</ul>
<!--End (temporary) beta sections-->

<ul class="sidebar-section">
<a href="{{ site.url | append: site.baseurl | append: localized_base_url }}/deploying">
<li class="title">{{ site.t[page.lang].deploying }}</li>
Copy link
Contributor

Choose a reason for hiding this comment

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

We should make this section header a conditional until there's a translated version

Copy link
Member Author

Choose a reason for hiding this comment

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

Added commit cef89ab to only display the Deployments section when there is content (including hiding the section header). Currently, this will hide the Deployments section for the Japanese translate.

@shaydewael my Jekyll/Liquid skills 🔪 are a little rusty. Would you mind looking at my implementation? If you have a more elegant way to do it, I'd love to see it!

docs/_deploying/heroku.md Outdated Show resolved Hide resolved
docs/_deploying/heroku.md Outdated Show resolved Hide resolved
docs/_deploying/heroku.md Outdated Show resolved Hide resolved
docs/_deploying/heroku.md Outdated Show resolved Hide resolved
docs/_deploying/heroku.md Outdated Show resolved Hide resolved
docs/_deploying/heroku.md Outdated Show resolved Hide resolved
docs/_deploying/heroku.md Outdated Show resolved Hide resolved
docs/_deploying/heroku.md Outdated Show resolved Hide resolved
docs/_deploying/heroku.md Outdated Show resolved Hide resolved
Copy link
Contributor

@misscoded misscoded left a comment

Choose a reason for hiding this comment

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

This is great and so important. It's going to help provide such a seamless experience for people that want to use Heroku to host. 🎉

docs/_deploying/heroku.md Outdated Show resolved Hide resolved
docs/_deploying/heroku.md Outdated Show resolved Hide resolved
docs/_deploying/heroku.md Outdated Show resolved Hide resolved
docs/_deploying/heroku.md Outdated Show resolved Hide resolved
docs/_deploying/heroku.md Outdated Show resolved Hide resolved
docs/_deploying/heroku.md Outdated Show resolved Hide resolved
docs/_deploying/heroku.md Outdated Show resolved Hide resolved
docs/_deploying/heroku.md Outdated Show resolved Hide resolved
docs/_deploying/heroku.md Outdated Show resolved Hide resolved
docs/_deploying/heroku.md Outdated Show resolved Hide resolved
mwbrooks added a commit to mwbrooks/bolt-js that referenced this pull request Oct 2, 2020
… in lang

This will hide the section for Japanese documentation until there is
a translation available.

- See slackapi#651 (comment)
Copy link
Member

@seratch seratch left a comment

Choose a reason for hiding this comment

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

Regarding the place to have the example app, as I mentioned in a comment, my suggestion is to have it under almost unused examples dir in this repo. But other options are also great. Apart from that, all look great to me.

@misscoded misscoded added the draft A pull request that is currently in active development and not yet ready for review label Oct 5, 2020
mwbrooks added a commit to mwbrooks/bolt-js that referenced this pull request Oct 5, 2020
mwbrooks added a commit to mwbrooks/bolt-js that referenced this pull request Oct 5, 2020
mwbrooks added a commit to mwbrooks/bolt-js that referenced this pull request Oct 5, 2020
… in lang

This will hide the section for Japanese documentation until there is
a translation available.

- See slackapi#651 (comment)
@mwbrooks mwbrooks force-pushed the 220-deployment-guides-heroku branch from f650ef1 to bb88411 Compare October 7, 2020 03:23
Copy link
Member

@seratch seratch left a comment

Choose a reason for hiding this comment

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

approved again - great work!

@mwbrooks mwbrooks merged commit c8eb6a6 into slackapi:main Oct 7, 2020
@mwbrooks mwbrooks deleted the 220-deployment-guides-heroku branch October 7, 2020 17:13
@mwbrooks mwbrooks mentioned this pull request Dec 10, 2020
19 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs M-T: Documentation work only
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants