Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added basic documentation for select widget #806

Merged
merged 1 commit into from
Dec 4, 2017

Conversation

ackushiw
Copy link
Contributor

- Summary
This helps people new to the platform with using the select widget and removes the need to go digging through code to work out the implementation.

- Test plan
Used english dictionary

- Description for the changelog
closes #764

Added basic documentation for select widget

- A picture of a cute animal (not mandatory but encouraged)
'cute animal'

Copy link
Contributor

@verythorough verythorough left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome. This also gets us one step closer to fully addressing #619. Thanks!
Could you add yourself to the contributor list? (Instructions here - we can also do the adding for you, if you prefer.)

Copy link
Contributor

@erquhart erquhart left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @ackushiw! Say, I noticed this doesn't quite close #764, so I've added a couple of requests to that end.

fields:
- {label: Title, name: title, widget: string, tagname: h1}
- {label: Body, name: body, widget: markdown}
- {label: Align Content, name: align, widget: select, options: ['left', 'center', 'right']}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Closing #764 requires documentation of adding labels and values, would you mind adding an example of that, too? You could even trim this code sample down and just show the field config examples, e.g.:

collections:
  - name: posts
     ...
     fields:
       ...
       - { label: Align Content, <rest of field> }
       - { label: Other example, <rest of field> }

@tech4him1
Copy link
Contributor

@ackushiw I think it would also be nice if we note that you can use the default setting, to set the default option.

@ackushiw
Copy link
Contributor Author

ackushiw commented Nov 12, 2017 via email

@verythorough
Copy link
Contributor

I'm going to merge this as an incremental improvement and keep #764 open for now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add instruction on how to add options to select widget
4 participants