search

FriendsOfSymfony / FOSRestBundle

This Bundle provides various tools to rapidly develop RESTful API's with Symfony
http://symfony.com/doc/master/bundles/FOSRestBundle/index.html
MIT License
2.79k stars 703 forks source link

Documentation is borked #2329

Closed CJDennis closed 2 years ago

CJDennis commented 3 years ago

https://github.com/FriendsOfSymfony/FOSRestBundle/blob/3.x/Resources/doc/index.rst is borked. None of the links work.

Other pages have similar issues. External links work, but all internal links seem to be borked.

mbabker commented 3 years ago

The docs were written to be included on symfony.com. With the new bundles documentation section, this bundle is no longer listed.

Assuming new maintainers are found, I'd suggest the docs be updated to be usable on GitHub (i.e. rewritten as Markdown instead of RST).

Th3Mouk commented 3 years ago

I can't find the issue, but this have already being discussed. The documentation has been unlist from symfony.com due to format changes. They are opened to relist this bundle on the website, but we must first of all comply to the new format.

W0rma commented 2 years ago

@goetas What's your opinion here? Should we try to get the documentation back to symfony.com or should we rather switch to plain Markdown files?

goetas commented 2 years ago

@W0rma do you have a guess on how much work is needed? Are available the new documentation rules?

having the docs on symfony.com would be nice, it just depends on how much work is needed.

W0rma commented 2 years ago

do you have a guess on how much work is needed? Are available the new documentation rules?

In know the documentation format but I don't know if there are special requirements for bundle documentation.

@javiereguiluz Do you have some hints what should be done in order to get the documentation of this bundle back to symfony.com? I'd be glad to help here.

javiereguiluz commented 2 years ago

@W0rma as @mbabker said, this bundle is no longer listed on symfony.com. There was an internal debate about which bundles to add/keep/remove and it was decided to remove this one in favor of promoting the usage of API Platform.

I know this can be disappointing, but please keep in mind that this decision is not about judging the technical merits of each bundle. Thanks!

goetas commented 2 years ago

will be solved by https://github.com/FriendsOfSymfony/FOSRestBundle/pull/2348