Skip to content

[Messenger] Added a learn more section #10018

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

Conversation

Nyholm
Copy link
Member

@Nyholm Nyholm commented Jul 5, 2018

There should be a link from the component page to the How to use Messenger page

@Nyholm
Copy link
Member Author

Nyholm commented Jul 6, 2018

Thank you

@javiereguiluz
Copy link
Member

@Nyholm in all the old (2.8) components we added this warning at the top of the article to end the confusion of readers thinking that the "component article" is the article explaining how to use the component inside a Symfony app. So we can do the same here ... and add your Learn More section too. Thanks!

javiereguiluz added a commit that referenced this pull request Jul 6, 2018
…uiluz)

This PR was submitted for the master branch but it was merged into the 4.1 branch instead (closes #10018).

Discussion
----------

[Messenger] Added a learn more section

There should be a link from the [component page](https://symfony.com/doc/current/components/messenger.html) to the [How to use Messenger page](https://symfony.com/doc/current/messenger.html)

Commits
-------

7faacfb Added a note about using the component in Symfony apps
07c3b43 Added a learn more section
@javiereguiluz
Copy link
Member

Update: in 3bbd822 I've removed the "Learn More" section because there are still no articles about Messenger in the messenger/ directory and the doc build was failing. We'll re-add it once we add new independent articles about Messenger. Thanks!

@Nyholm Nyholm deleted the patch-messenger-learn-more branch July 6, 2018 06:57
@Nyholm
Copy link
Member Author

Nyholm commented Jul 6, 2018

It should still be a reference to /messenger though.

https://github.com/symfony/symfony-docs/blob/master/messenger.rst

@javiereguiluz
Copy link
Member

Yes ... but we now add the reference to /messenger.rst at the beginning of the article, like we do in all the other component articles. When we add more independent articles about the Messenger, we can add the "Learn More" section.

Keep in mind the comments of the other PRs too: if the new proposed articles are too small, they should be just sections of the main article. We're working hard to simplify Symfony Docs, so we no longer merge very short articles. Thanks for your understanding!

@Nyholm
Copy link
Member Author

Nyholm commented Jul 6, 2018

Good!

Yes, thank you.

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.

3 participants