Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • A administrate
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 96
    • Issues 96
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 32
    • Merge requests 32
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • thoughtbot, inc.
  • administrate
  • Issues
  • #1778
Closed
Open
Issue created Sep 24, 2020 by Pablo Brasero@pablobmContributor3 of 12 checklist items completed3/12 checklist items

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?
    • https://github.com/thoughtbot/administrate/issues/1756
  • How to override only specific parts of templates.
    • https://github.com/thoughtbot/administrate/issues/1661
    • https://github.com/thoughtbot/administrate/issues/1315
  • How to use Administrate with an api_only Rails app.
    • https://github.com/thoughtbot/administrate/issues/1755
  • How to add a button to export data to CSV.
    • https://github.com/thoughtbot/administrate/issues/1520
  • How to add functionality to import data from CSV.
    • https://stackoverflow.com/questions/66247220/best-way-to-do-csv-seed-file-upload-to-rails-repo-through-administrate
  • 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.
    • https://github.com/thoughtbot/administrate/pull/1998#issuecomment-907576069
  • Create a variation of Field::HasOne that only links to the associated record, instead of displaying it on the show page.
    • https://github.com/thoughtbot/administrate/issues/1877
  • How to edit users managed by Devise
    • https://github.com/thoughtbot/administrate/issues/495

Done

  • How to hide dashboards from the sidebar.
    • https://github.com/thoughtbot/administrate/issues/1587
    • ✔ Done at https://github.com/thoughtbot/administrate/pull/1781
  • How to provide custom search logic.
    • https://github.com/thoughtbot/administrate/pull/2096
    • ✔ Done at https://github.com/thoughtbot/administrate/pull/2153
  • How to scope HasMany tables.
    • https://stackoverflow.com/questions/59059701/rails-administrate-customize-has-many
    • ✔ Done at https://github.com/thoughtbot/administrate/pull/2243

For clarity, I would add this section to the current documentation files, as opposed to a GitHub wiki like Devise does.

Assignee
Assign to
Time tracking