thoughtbot/administrate

Documentation suggestion for nested forms - HasOne

Open

#1013 opened on Oct 25, 2017

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Ruby (5,765 stars) (1,110 forks)batch import
bugdocumentationgood first issue

Description

It would be useful to explain that in order to have a has_one association in a form, one has to add

  has_one :thing
  accepts_nested_attributes_for :thing

to the parent model. Saying this because the Field::HasOne already supports nested form and allows the params.

https://github.com/thoughtbot/administrate/blob/3366bd10a4afaf5bc0c63ea0f5ecc12b5d1bae31/lib/administrate/field/has_one.rb#L8

Contributor guide

Tech stack
rubyrails
Domain
backend
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Ruby on Rails basicsAdministrate gem usage
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
Add documentation to the Administrate README or user guide explaining that for has one associations, you need to add 'has one :thing' and 'accepts nested attributes for :thing' to the parent model. Reference the Field::HasOne component and the linked source file (lib/administrate/field/has one.rb). Ensure consistency with existing nested form documentation.