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 Action Mailbox to guides #34812

Merged
merged 3 commits into from Dec 30, 2018

Conversation

bogdanvlviv
Copy link
Contributor

@bogdanvlviv bogdanvlviv commented Dec 27, 2018

  • Move some actionmailbox/README.md content to Action Mailbox Basics guide
    I added WIP label to that guide since we definitely want to complement it.
  • Fix Action Mailer Basics
    Now Action Mailbox is responsible for receiving emails.
  • Add Action Mailbox to Major Features of Rails 6.0

Related to #34786
Closes #34819
r? @georgeclaghorn

Copy link
Contributor

@georgeclaghorn georgeclaghorn left a comment

Choose a reason for hiding this comment

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

Great start!

* How to receive email within a Rails application.
* How to configure Action Mailbox.
* How to generate and setup a mailbox.
* How to test test incoming emails.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* How to test test incoming emails.
* How to test incoming emails.


* How to receive email within a Rails application.
* How to configure Action Mailbox.
* How to generate and setup a mailbox.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* How to generate and setup a mailbox.
* How to generate and route emails to a mailbox.


## Setup

Install migrations needed for `InboundEmail` and ensure Active Storage is setup:
Copy link
Contributor

Choose a reason for hiding this comment

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

I know this is fussy, but setup is a noun. Set up is the verb form.

Suggested change
Install migrations needed for `InboundEmail` and ensure Active Storage is setup:
Install migrations needed for `InboundEmail` and ensure Active Storage is set up:

$ rails db:migrate
```

## Configuring
Copy link
Contributor

Choose a reason for hiding this comment

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

This came from the README, but can we go with “Configuration” here?

Suggested change
## Configuring
## Configuration

end
```

Then setup a mailbox:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Then setup a mailbox:
Then set up a mailbox:

…guide [ci skip]

I added WIP label to that guide since we definitely
want to complement it.
Now Action Mailbox is responsible for receiving emails.
@bogdanvlviv
Copy link
Contributor Author

bogdanvlviv commented Dec 30, 2018

Thank you for the review! 🙇‍♂️ I just fixed the mentioned typos.

@georgeclaghorn georgeclaghorn merged commit a1be11f into rails:master Dec 30, 2018
@bogdanvlviv bogdanvlviv deleted the action_mailbox-guides-docs branch December 30, 2018 01:21
bogdanvlviv added a commit to bogdanvlviv/rails that referenced this pull request Jan 5, 2019
- Move some actiontext/README.md content to Action Text Overview guide
- I added WIP label to that guide since we definitely want to complement it.
- Add Action Text to Major Features of Rails 6.0

Similar approach was used in rails#34812
bogdanvlviv added a commit to bogdanvlviv/rails that referenced this pull request Jan 13, 2019
…skip]

In rails#34709 we updated the guide, but `actioncable/README.md` is still
outdated. Instead of fixing content in the file. I suggest
not duplicate the info that is already in the guide and instead remove
the info from the file and just add a message:
"You can read more about Action Cable in the
[Action Cable Overview](https://edgeguides.rubyonrails.org/action_cable_overview.html) guide."

The same approach is being used for Action Mailbox and Action Text,
see rails#34812 and rails#34878.
bogdanvlviv added a commit to bogdanvlviv/rails that referenced this pull request Jan 21, 2019
We added "Action Mailbox Basics", "Action Text Overview" guides(rails#34812, rails#34878)
I think it makes to mention about it in the changelog file. (Similar to 7200ec9)
Note that entries retain original author since
I just moved content from readme files to the guides.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants