Skip to content

Added hints to spool config section #5848

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

Closed
wants to merge 2 commits into from
Closed

Added hints to spool config section #5848

wants to merge 2 commits into from

Conversation

martinczerwi
Copy link
Contributor

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

The former explanation suggests that a single file is used for spooling, which is not the case of course. But I ran into that problem and since Symfony falls back to memory if the dir is not writable (as it seems) with no error message, this addition might help some people to get spools running.

The former explanation suggests that a single file is used for spooling, which is not the case of course. But I ran into that problem and since Symfony falls back to memory if the dir is not writable (as it seems) with no error message, this addition might help some people to get spools running.
@@ -55,10 +55,15 @@ swiftmailer with the memory option, use the following configuration:
'spool' => array('type' => 'memory')
));

Spool Using a File
Spool Using Files
Copy link
Member

Choose a reason for hiding this comment

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

We should add label for the old headline before:

.. _spool-using-a-file:

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'm sorry, I don't get it. The Table of contents is updated automatically. Why should we do this?

Copy link
Member

Choose a reason for hiding this comment

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

With a little icon next to each headline on symfony.com, we allow the readers to link to specific sections on a page. This is done by using the automatically created anchor (slugified headline text).

If we change the headline, the automatically generated anchor changes as well (in this case it was spool-using-a-file and now is spool-using-files). This means that all links to the specific section are broken. If we add the old anchor as well, both anchors will link to this section. It's like backwards compatibility for documentations.

@javiereguiluz
Copy link
Member

@martinczerwi 👍 your pull request looks like a very nice (and needed) addition to the spool docs. Thank you!

A question to doc maintainers: can we label this PR as "finished"? Thanks.

@xabbuh
Copy link
Member

xabbuh commented Dec 30, 2015

👍 looks great

Sorry I did not notice earlier that you made the required change @martinczerwi, but we do not get any notifications when new commits are pushed to a pull request. Just leave a comment when you make some changes to a PR and we will receive notifications. :)

xabbuh added a commit that referenced this pull request Dec 31, 2015
This PR was submitted for the 2.7 branch but it was merged into the 2.3 branch instead (closes #5848).

Discussion
----------

Added hints to spool config section

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

The former explanation suggests that a single file is used for spooling, which is not the case of course. But I ran into that problem and since Symfony falls back to memory if the dir is not writable (as it seems) with no error message, this addition might help some people to get spools running.

Commits
-------

a460028 Added hints to spool config section
@xabbuh
Copy link
Member

xabbuh commented Dec 31, 2015

Thank you for these nice improvements and sorry for the delay @martinczerwi. I have merged your changes into the 2.3 branch. That's why your pull request is shown as closed instead of merged. But you will get the full credit for your contribution nonetheless.

@xabbuh xabbuh closed this Dec 31, 2015
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.

4 participants