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

[Cookbook] New cookbok: How to use the Cloud to send Emails #3234

Closed
wants to merge 3 commits into from
Closed

[Cookbook] New cookbok: How to use the Cloud to send Emails #3234

wants to merge 3 commits into from

Conversation

bicpi
Copy link
Contributor

@bicpi bicpi commented Nov 28, 2013

Q A
Doc fix? no
New docs? yes
Applies to all
Fixed tickets -

This is a new cookbook article as proposed in #3193, I hope you like it.

Please let me know if there's something I can improve, especially regarding my English ;-)

.. index::
single: Emails; Cloud

How to use the Cloud to send Emails
Copy link
Member

Choose a reason for hiding this comment

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

Maybe I'm wrong but shouldn't this be "How to Use the Cloud to Send E-Mails" according to our new guidelines?

Copy link
Member

Choose a reason for hiding this comment

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

At least I prefer E-Mail over Email

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've used the Gmail cookbook as a base for this one.
So if we change it we may should change it in the whole docs, otherwise it would for example read like

  • How to use Gmail to send Emails
  • How to use the Cloud to Send E-Mails
    in the TOC.

Btw, I've found a lot of such words that are spelled differently across the docs; I'll create an issue listing them, we could vote for the correct one and then I'll update the docs.

@bicpi bicpi mentioned this pull request Nov 29, 2013
@bicpi
Copy link
Contributor Author

bicpi commented Dec 1, 2013

Thanks @xabbuh and @wouterj for your feedback, I've implemented the most of it, except "email" vs. "e-mail", see also #3237 - "email" seems to be used more in the docs and in general.

I've also applied the changes to the Gmail cookbook, where applicable:

  • heading notation
  • full XML configuration
  • single/double quotes in PHP
  • typo

port="465"
encryption="tls"
username="AWS_ACCESS_KEY"
password="AWS_SECRET_KEY" />
Copy link
Member

Choose a reason for hiding this comment

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

I prefer to put /> on a new line, on the same indent level as the open tag

@bicpi
Copy link
Contributor Author

bicpi commented Dec 3, 2013

Any agreement on the email vs. e-mail topic?

Currently, e-mail is only used 5x throughout the docs - would be an easy fix.

@bicpi
Copy link
Contributor Author

bicpi commented Jan 4, 2014

After some more research, the unhyphenated email form is more common, can we agree on this?

@weaverryan
Copy link
Member

This is a really nice entry - I appreciate the detail about parameters.yml and the notes at the bottom. Really great job Philipp!

weaverryan added a commit that referenced this pull request Mar 5, 2014
…ails (bicpi)

This PR was submitted for the 2.2 branch but it was merged into the 2.3 branch instead (closes #3234).

Discussion
----------

[Cookbook] New cookbok: How to use the Cloud to send Emails

| Q             | A
| ------------- | ---
| Doc fix?      | no
| New docs?     | yes
| Applies to    | all
| Fixed tickets | -

This is a new cookbook article as proposed in #3193, I hope you like it.

Please let me know if there's something I can improve, especially regarding my English ;-)

Commits
-------

6bbbc8a Fix wording and formatting
4f7c0f3 Fixes and improvements after review
3490722 [Cookbook] New cookbok: How to use the Cloud to send Emails
@weaverryan weaverryan closed this Mar 5, 2014
@bicpi
Copy link
Contributor Author

bicpi commented Mar 5, 2014

@weaverryan Thank you ☺️

@xabbuh
Copy link
Member

xabbuh commented Mar 8, 2014

Is there a problem with the build process? The merge has been performed a few days ago but is still not reflected in the docs.

@bicpi
Copy link
Contributor Author

bicpi commented Mar 8, 2014

Are the docs rebuilt every night or when does it happen actually?

@xabbuh
Copy link
Member

xabbuh commented Mar 8, 2014

According to the contributing docs it should be:

[...] it is updated each French night at 3AM when the server rebuilds the documentation [...]

@bicpi
Copy link
Contributor Author

bicpi commented Mar 8, 2014

Oh, thanks, I remember reading that a long time ago!

@wouterj
Copy link
Member

wouterj commented Mar 8, 2014

In that same article:

Please be patient. It can take from 15 minutes to several days for your changes to appear on the symfony.com website after the documentation team merges your pull request.

I suggest we wait for a couple more days, it's wuite random if you ask me

@weaverryan
Copy link
Member

Yea, I would also have expected it to have been built by now too - iirc, it does a simple build every 15 minutes (not sure what it entails, but maybe only updated docs) and a full, fresh one nightly.

Let's wait a few days and then start bothering some people :) (I don't have access to this part either)

@wouterj
Copy link
Member

wouterj commented Mar 8, 2014

yeah, with the cmf, new images are usually uploaded during the night and new text quite fast after merging. However, this is a bit random, as I always have the feeling that CMF is quicker updated as this doc and I added "to several days" after it took a full week before my PR was build online.

@xabbuh
Copy link
Member

xabbuh commented Mar 12, 2014

I feel like the build process currently doesn't work at all. The build errors page shows only outdated errors.

@wouterj
Copy link
Member

wouterj commented Mar 12, 2014

ping @javiereguiluz (sorry for pinging you so often)

@javiereguiluz
Copy link
Member

@wouterj looking into it! And don't worry for the pings, because you can (and should) ping me as many times as you need.

@javiereguiluz
Copy link
Member

@xabbuh @wouterj the documentation build errors are updated again thanks to @fabpot

You can see them at http://symfony.com/doc/build_errors

@xabbuh
Copy link
Member

xabbuh commented Mar 13, 2014

@javiereguiluz Great! Thank you! Now, this new cookbook article is also available.

@xabbuh
Copy link
Member

xabbuh commented Mar 13, 2014

Fixed the build errors in #3650.

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