Create a "how to" section in the documentation
I think that our documentation is pretty good for experienced Rails developers, who know the conventions well and just want to get going. However I feel that it falls short for those who are a bit newer to the framework. Many things are left unsaid because they are implied in the conventions of the community. Newcomers are less aware of these and will struggle.
A way to solve this could be to create a "how to" section in our documentation, similar to the one offered by Devise: https://github.com/heartcombo/devise/wiki/How-Tos. These are some initial ideas of articles there, taken from actual questions from users:
-
How to do file processing / parsing? -
How to override only specific parts of templates. -
How to use Administrate with an api_only
Rails app. -
How to add a button to export data to CSV. -
How to add functionality to import data from CSV. -
How to add a "create and add another" button in the new
page. -
How to add authentication and make it work with the existing authorization facility. -
Create a variation of Field::HasOne
that only links to the associated record, instead of displaying it on the show page. -
How to edit users managed by Devise
Done
-
How to hide dashboards from the sidebar. -
How to provide custom search logic. -
How to scope HasMany
tables.
For clarity, I would add this section to the current documentation files, as opposed to a GitHub wiki like Devise does.