Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Contributions to Serializer docs are paused #17814

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
javiereguiluz opened this issue Jan 27, 2023 · 7 comments
Closed

Contributions to Serializer docs are paused #17814

javiereguiluz opened this issue Jan 27, 2023 · 7 comments

Comments

@javiereguiluz
Copy link
Member

javiereguiluz commented Jan 27, 2023

Because of the revamp in the Serializer docs (see #17783) we are pausing all changes and merges to any docs related to Serializer.

Please, don't contribute anything related to Serializer until we finish that revamp. Thanks for understanding!

Pinging the most active contributors (@alexandre-daubois, @alamirault, @94noni) and mergers (@weaverryan, @OskarStark, @xabbuh) so everybody is warned about this. Thanks!

@alexandre-daubois
Copy link
Member

alexandre-daubois commented Jan 27, 2023

Got it ๐Ÿ‘

Would it be conceivable to imagine a work like the unification of the doc of the Console component for example? As @wouterj raised on one of my PRs, it seems that the trend is to unify the component docs rather than exploding them into several articles. If this is something that could be planned, I would be happy to take care of it for Console for instance ๐Ÿ™‚

@94noni
Copy link
Contributor

94noni commented Jan 27, 2023

@javiereguiluz oki thx for ping :)
i've understand it is a global offer to rewrite doc on component & framework usage
do you have like a roadmap for that? and also writing in symfony/doc vs symfony/symfony 's readme?

thx

@wouterj
Copy link
Member

wouterj commented Jan 27, 2023

Hi! Thank you both for asking how to help with the rewrites.

For now, I would suggest to let us (the doc team) do the main bulk of the work. PRs like this get pretty big, so it's easier to coordinate, review and quickly discuss approaches this way. When the bulk of the work is done, there probably still are tons of things that can be restructured or better worded that you can help with. And of course, reviews on these big PRs are also always very welcome :)

Thanks for all the work and excitement around documentation! :)

@alexandre-daubois
Copy link
Member

Understood, good luck ๐Ÿ’ช

@alexandre-daubois
Copy link
Member

Hey! Just a quick message to know if contributions to the serializer are still paused? ๐Ÿ™‚

@wouterj
Copy link
Member

wouterj commented Jun 18, 2023

I have very little OSS time this month (preparing and executing a big migration at work). I hope to pick up this PR again in July.

I would say adding small sections to document new features is OK (given this is taken longer than I wanted). But let's not rewrite, restructure, add missing docs for features of historic versions, etc. as that'll just be double work and the docs have been in this state for years, so we can survive it for another couple of months.

@javiereguiluz
Copy link
Member Author

I'm closing this issue because the main doc contributors are aware of it and because we're merging small changes and additions to the serializer component. We won't merge revamps or huge changes to help with the update. Thanks!

wouterj added a commit that referenced this issue Nov 23, 2024
โ€ฆterj)

This PR was merged into the 6.4 branch.

Discussion
----------

Combine component and framework docs for Serializer

A very early PR, to avoid someone else working on this as well (especially `@fabpot` who is on fire with this type of PRs lately).

The serializer docs are the most unfortunate component - framework documentation situations I think, with most of the docs in the component docs instead of framework one. This PR is focused on combining all the information in the framework guide as a start.

closes #17814

Commits
-------

8a1497b Combine component and framework docs for Serializer
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants