Please sign in to comment.
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Remove documentation tasks
This patch removes the tasks doc:app, doc:rails, and doc:guides. In our experience applications do not generate APIs using doc:app. Methods may be certainly documented for maintainers, annotated with YARD tags, etc. but that is intended to be read with the source code, not in a separate website. Then, teams also have typically selected topics written down in Markdown files, or in a GitHub wiki... that kind of thing. If a team absolutely needs to generate application documentation for internal purposes, they can still easily write their own task. Regarding doc:rails and doc:guides, we live in 2015. We are used to go to online docs all the time. If you really want access to the API offline RubyGems generates it for every Rails component unless you tell it not to, and you can checkout the Rails source code to read the guides as Markdown, or download them for a Kindle reader. All in all, maintaining this code does not seem to be worthwhile anymore. As a consequence of this, guides (+3 MB uncompressed) won't be distributed with the rails gem anymore. Of course, guides and API are going to be still part of releases, since documentation is maintained alongside code and tests. Also, time permitting, this will allow us to experiment with novel ways to generate documentation in the Rails docs server, since right now we were constrained by being able to generate them in the user's environment.
- Loading branch information
Showing with 5 additions and 121 deletions.
- +0 −8 guides/source/command_line.md
- +0 −13 guides/source/getting_started.md
- +1 −1 rails.gemspec
- +4 −0 railties/CHANGELOG.md
- +0 −14 railties/lib/rails/api/task.rb
- +0 −6 railties/lib/rails/generators/app_base.rb
- +0 −4 railties/lib/rails/generators/rails/app/templates/README.rdoc
- +0 −70 railties/lib/rails/tasks/documentation.rake
- +0 −5 railties/test/generators/app_generator_test.rb
There are no files selected for viewing
Oops, something went wrong.