Skip to content

[RF DOCS] Action Mailbox Guides#1

Open
bhumi1102 wants to merge 56 commits intomainfrom
bhumi-guides-action-mailbox
Open

[RF DOCS] Action Mailbox Guides#1
bhumi1102 wants to merge 56 commits intomainfrom
bhumi-guides-action-mailbox

Conversation

@bhumi1102
Copy link
Owner

@bhumi1102 bhumi1102 commented Jan 31, 2024

Overview

Action Mailbox is a pretty useful / interesting sub-framework of Rails, that more apps probably could benefit from. It does have a number of moving parts so I focused on explaining the flow of how things work. I did a lot of 'in-app testing' of the docs by implementing its features in a rails app and exploring what's missing in the docs.

New sections

Here are the new things I added, in addition to clarifying the existing text.

  • Processing Incoming Email - more of a step by step of the flow
  • Mail object and it's fields
  • List of Inbound Email 'status' values
  • ActiveJobs that are part of Action Mailbox - Routing and Incineration

Testing

In addition to testing the Action Mailbox features in-app, I also ran guides:generate and guides:validate locally and got the All checked guides validate OK! output. I perused the generated html locally as well.

Follow-on Task

Moving the Ingress Configuration: the Ingress configuration section reads more like a reference/appendix to me. I think it'd make sense to move that to the end of the doc. With a smaller section with the common steps in its current place (create secure pwd, update config.action_mailbox.ingress) and then point to the bottom of the docs for details on the specific. I did not do that yet as I wanted to focus on adding the new sections first instead of moving things around.

I did test the instructions for one 'real' ingress Postmark (locally with ngrok). I did not test all the other ones (as Carlos mentioned it's be too much).

Copy link
Collaborator

@Ridhwana Ridhwana left a comment

Choose a reason for hiding this comment

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

This reads really clear and concise 😊 . I left a few non-blocking suggestions.

Copy link
Collaborator

@carlosantoniodasilva carlosantoniodasilva 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 looking great! I just had a few bits of feedback, mostly links I think we can add to make navigation within the doc easier, and some small suggestions here and there. Let me know if you have any questions.

bhumi1102 and others added 9 commits February 5, 2024 10:27
Co-authored-by: Ridhwana <Ridhwana.Khan16@gmail.com>
Co-authored-by: Ridhwana <Ridhwana.Khan16@gmail.com>
Co-authored-by: Carlos Antonio da Silva <carlosantoniodasilva@gmail.com>
Co-authored-by: Petrik de Heus <petrik@deheus.net>
Co-authored-by: Petrik de Heus <petrik@deheus.net>
Co-authored-by: Carlos Antonio da Silva <carlosantoniodasilva@gmail.com>
Co-authored-by: Carlos Antonio da Silva <carlosantoniodasilva@gmail.com>
bhumi1102 and others added 7 commits February 6, 2024 09:49
Co-authored-by: Carlos Antonio da Silva <carlosantoniodasilva@gmail.com>
Co-authored-by: Carlos Antonio da Silva <carlosantoniodasilva@gmail.com>
Co-authored-by: Carlos Antonio da Silva <carlosantoniodasilva@gmail.com>
Co-authored-by: Carlos Antonio da Silva <carlosantoniodasilva@gmail.com>
@bhumi1102
Copy link
Owner Author

bhumi1102 commented Feb 6, 2024

Great updates! I had one thought about a possible small addition to the routing section that may be worth mentioning, and a couple other minor bits to consider, but otherwise this LGTM. Thanks @bhumi1102!

Awesome. Thank you for the great thorough review @carlosantoniodasilva! Looking forward to merging this to rails/rails after our 'community feedback window'.

bhumi1102 and others added 21 commits February 7, 2024 13:53
Co-authored-by: T.J. Schuck <tj@tjschuck.com>
Co-authored-by: T.J. Schuck <tj@tjschuck.com>
Co-authored-by: T.J. Schuck <tj@tjschuck.com>
Co-authored-by: T.J. Schuck <tj@tjschuck.com>
Co-authored-by: T.J. Schuck <tj@tjschuck.com>
Co-authored-by: T.J. Schuck <tj@tjschuck.com>
Co-authored-by: T.J. Schuck <tj@tjschuck.com>
Co-authored-by: T.J. Schuck <tj@tjschuck.com>
Co-authored-by: Carlos Antonio da Silva <carlosantoniodasilva@gmail.com>
Co-authored-by: Carlos Antonio da Silva <carlosantoniodasilva@gmail.com>
Co-authored-by: Carlos Antonio da Silva <carlosantoniodasilva@gmail.com>
Co-authored-by: Carlos Antonio da Silva <carlosantoniodasilva@gmail.com>
Co-authored-by: T.J. Schuck <tj@tjschuck.com>
The status changes as the email goes through the various steps.
When generating the content, it was forcing a line break between
ActionMailbox::Base and API, causing the output HTML content to be
weird. Removing API and wrapping all content again at 80 columns fixes
it.
@bhumi1102 bhumi1102 mentioned this pull request Apr 26, 2024
11 tasks
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.

5 participants