Open
Conversation
…ils into bhumi-guides-action-mailbox
Ridhwana
approved these changes
Feb 2, 2024
Collaborator
Ridhwana
left a comment
There was a problem hiding this comment.
This reads really clear and concise 😊 . I left a few non-blocking suggestions.
AmandaPerino
reviewed
Feb 2, 2024
AmandaPerino
reviewed
Feb 2, 2024
AmandaPerino
reviewed
Feb 2, 2024
p8
reviewed
Feb 3, 2024
p8
reviewed
Feb 3, 2024
p8
reviewed
Feb 3, 2024
Collaborator
carlosantoniodasilva
left a comment
There was a problem hiding this comment.
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.
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>
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>
Owner
Author
Awesome. Thank you for the great thorough review @carlosantoniodasilva! Looking forward to merging this to rails/rails after our 'community feedback window'. |
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.
Testing
In addition to testing the Action Mailbox features in-app, I also ran
guides:generateandguides:validatelocally and got theAll 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).