Skip to content

Commit

Permalink
Merge pull request #123 from forestryio/front-matter-ux-update
Browse files Browse the repository at this point in the history
Front matter ux update
  • Loading branch information
dwalkr authored Apr 23, 2019
2 parents 39a87e5 + a2ea277 commit 84c46cd
Show file tree
Hide file tree
Showing 32 changed files with 395 additions and 325 deletions.
54 changes: 27 additions & 27 deletions hugo/.forestry/front_matter/templates/changelog.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,31 +40,31 @@ fields:
hidden: true
default: ''
pages:
- hugo/content/docs/changelog/2019-04-05-changelog.md
- hugo/content/docs/changelog/2019-03-29-changelog.md
- hugo/content/docs/changelog/2019-03-08-changelog.md
- hugo/content/docs/changelog/2019-03-01-changelog.md
- hugo/content/docs/changelog/2019-01-09-changelog.md
- hugo/content/docs/changelog/2018-12-18-changelog.md
- hugo/content/docs/changelog/2018-12-07-changelog.md
- hugo/content/docs/changelog/2018-11-27-changelog.md
- hugo/content/docs/changelog/2018-10-30-changelog.md
- hugo/content/docs/changelog/2018-10-18-changelog.md
- hugo/content/docs/changelog/2018-10-16-changelog.md
- hugo/content/docs/changelog/2018-10-11-changelog.md
- hugo/content/docs/changelog/20181005-changelog.md
- hugo/content/docs/changelog/20181001-changelog.md
- hugo/content/docs/changelog/20180928-changelog.md
- hugo/content/docs/changelog/20180919-Changelog.md
- hugo/content/docs/changelog/2018-09-14-changelog.md
- hugo/content/docs/changelog/2018-09-12-changelog.md
- hugo/content/docs/changelog/2018-09-10-changelog.md
- hugo/content/docs/changelog/2018-09-07-changelog.md
- hugo/content/docs/changelog/2018-08-10-changelog.md
- hugo/content/docs/changelog/2018-08-08-changelog.md
- hugo/content/docs/changelog/2018-08-06-changelog.md
- hugo/content/docs/changelog/2018-08-17-changelog.md
- hugo/content/docs/changelog/2018-08-30-changelog.md
- hugo/content/docs/changelog/2018-08-29-changelog.md
- hugo/content/docs/changelog/2018-08-28-changelog.md
- hugo/content/docs/changelog/2018-08-15-changelog.md
- hugo/content/docs/changelog/2018-08-28-changelog.md
- hugo/content/docs/changelog/2018-08-29-changelog.md
- hugo/content/docs/changelog/2018-08-30-changelog.md
- hugo/content/docs/changelog/2018-08-17-changelog.md
- hugo/content/docs/changelog/2018-08-06-changelog.md
- hugo/content/docs/changelog/2018-08-08-changelog.md
- hugo/content/docs/changelog/2018-08-10-changelog.md
- hugo/content/docs/changelog/2018-09-07-changelog.md
- hugo/content/docs/changelog/2018-09-10-changelog.md
- hugo/content/docs/changelog/2018-09-12-changelog.md
- hugo/content/docs/changelog/2018-09-14-changelog.md
- hugo/content/docs/changelog/20180919-Changelog.md
- hugo/content/docs/changelog/20180928-changelog.md
- hugo/content/docs/changelog/20181001-changelog.md
- hugo/content/docs/changelog/20181005-changelog.md
- hugo/content/docs/changelog/2018-10-11-changelog.md
- hugo/content/docs/changelog/2018-10-16-changelog.md
- hugo/content/docs/changelog/2018-10-18-changelog.md
- hugo/content/docs/changelog/2018-10-30-changelog.md
- hugo/content/docs/changelog/2018-11-27-changelog.md
- hugo/content/docs/changelog/2018-12-07-changelog.md
- hugo/content/docs/changelog/2018-12-18-changelog.md
- hugo/content/docs/changelog/2019-01-09-changelog.md
- hugo/content/docs/changelog/2019-03-01-changelog.md
- hugo/content/docs/changelog/2019-03-08-changelog.md
- hugo/content/docs/changelog/2019-03-29-changelog.md
- hugo/content/docs/changelog/2019-04-05-changelog.md
190 changes: 95 additions & 95 deletions hugo/.forestry/front_matter/templates/default.yml
Original file line number Diff line number Diff line change
Expand Up @@ -140,99 +140,99 @@ fields:
name: menu
label: menu
pages:
- hugo/content/blog/gulp-and-webpack-best-of-both-worlds.md
- hugo/content/careers/developer-evangelist-1.md
- hugo/content/careers/_index.md
- hugo/content/blog/versioning-large-files-with-git-lfs.md
- hugo/content/blog/what-are-instant-previews.md
- hugo/content/blog/full-speed-ahead-in-2019.md
- hugo/content/careers/developer-evangelist.md
- hugo/content/blog/hugo-support-sorting-for-pages-and-more.md
- hugo/content/blog/statyc-a-luxury-festival-for-hackers.md
- hugo/content/careers/user-experience-ux-researcher.md
- hugo/content/careers/marketing.md
- hugo/content/careers/hiring-a-senior-ruby-developer.md
- hugo/content/careers/devrel.md
- hugo/content/careers/hiring-devops-engineer.md
- hugo/content/blog/3-patterns-for-loading-data-with-react.md
- hugo/content/blog/new-pricing-organization-accounts.md
- hugo/content/blog/ftp-an-outdated-deployment-method-for-static-sites.md
- hugo/content/blog/how-to-use-hugo-s-image-processing-with-forestry.md
- hugo/content/blog/a-hugo-update-everyone-should-be-talking-about.md
- hugo/content/blog/data-relationships-in-hugo.md
- hugo/content/blog/add-functionality-to-your-hugo-site-with-theme-components.md
- hugo/content/blog/how-i-reduced-my-jekyll-build-time-by-61.md
- hugo/content/careers/hiring-technical-support.md
- hugo/content/blog/forestry-git-backed-content-management-for-gatsby.md
- hugo/content/asdd.md
- hugo/content/blog/is-it-time-to-move-on-from-wordpress.md
- hugo/content/blog/better-content-management-for-gatsby.md
- hugo/content/blog/spike-test-reset.md
- hugo/content/blog/new-improve-media-gallery.md
- hugo/content/blog/data-files-directories-and-duplicating-pages.md
- hugo/content/blog/an-introduction-to-theming-in-vuepress.md
- hugo/content/blog/ubuild-a-new-theme-for-static-sites-using-blocks.md
- hugo/content/blog/form-builder-with-formspree-forestry-blocks.md
- hugo/content/blog/demystifying-hugo-conditionals.md
- hugo/content/blog/Using-JSON-Configuration-With-VuePress.md
- hugo/content/blog/Introducing-Custom-Build-Commands.md
- hugo/content/blog/create-in-app-documentation-for-content-editors.md
- hugo/content/blog/5-options-for-automating-your-software-deployments.md
- hugo/content/blog/adding-dns-and-edge-functions-to-our-cloudformation-stack.md
- hugo/content/blog/custom-configuration-for-data-files.md
- hugo/content/blog/improved-collaboration-and-more.md
- hugo/content/blog/introducing-media-management.md
- hugo/content/blog/layout-improvements.md
- hugo/content/blog/vuepress-support-beta.md
- hugo/content/blog/5-ways-to-handle-forms-on-your-static-site.md
- hugo/content/blog/for-static-sites-theres-no-excuse-not-to-use-a-cdn.md
- hugo/content/blog/building-a-company-component-library.md
- hugo/content/blog/migrating-to-key-based-authentication.md
- hugo/content/blog/renaming-files-and-improving-team-editing.md
- hugo/content/blog/forestry-gitlab.md
- hugo/content/blog/introducing-forestry-config-files.md
- hugo/content/blog/cloudinary-integration.md
- hugo/content/blog/creating-a-multilingual-blog-with-jekyll.md
- hugo/content/blog/customize-sidebar-and-assign-front-matter-templates.md
- hugo/content/blog/automate-your-static-hosting-environment-with-aws-cloudformation.md
- hugo/content/blog/block-labels-read-only-docs-and-more.md
- hugo/content/blog/vuepress-brings-your-documentation-to-life.md
- hugo/content/blog/harness-the-power-of-static-to-create-presentations.md
- hugo/content/blog/build-a-json-api-with-hugo.md
- hugo/content/blog/snippets-custom-content-sections-and-more.md
- hugo/content/docs/_index.md
- hugo/content/docs/troubleshooting
- hugo/content/docs/git-sync
- hugo/content/docs/faqs
- hugo/content/blog/why-we-created-a-git-backed-content-manager.md
- hugo/content/blog/big-improvements-to-front-matter-templates.md
- hugo/content/blog/wysiwyg-formatting-in-front-matter.md
- hugo/content/blog/forestryio-techstars-2016.md
- hugo/content/blog/3-tips-for-mastering-blocks.md
- hugo/content/blog/the-new-forestry-io.md
- hugo/content/blog/march-27th-service-outage.md
- hugo/content/blog/discontinuing-wysiwyg-editor-new-focus-on-markdown.md
- hugo/content/blog/_index.md
- hugo/content/blog/up-and-running-with-hugo-part-2.md
- hugo/content/blog/up-and-running-with-hugo.md
- hugo/content/blog/search-with-algolia-in-hugo.md
- hugo/content/blog/sawmill-layout-composer-for-hugo-and-forestry.md
- hugo/content/careers/software-engineer.md
- hugo/content/careers/full-stack.md
- hugo/content/blog/what-s-new-in-jekyll-3-4-0.md
- hugo/content/blog/search-with-algolia-in-jekyll.md
- hugo/content/blog/discontinuing-zip-sites.md
- hugo/content/blog/front-matter-templates.md
- hugo/content/blog/bigger-better-editor.md
- hugo/content/terms.md
- hugo/content/blog/why-we-built-forestry.md
- hugo/content/blog/landing-page-create-static-site-copy.md
- hugo/content/blog/instant-production-ready-scaffolding-with-create-static-site.md
- hugo/content/blog/choose-static.md
- hugo/content/blog/hugo-and-jekyll-compared.md
- hugo/content/blog/join-our-slack-community.md
- hugo/content/careers/admin.md
- hugo/content/blog/what-s-new-in-jekyll-3.8.md
- hugo/content/blog/test.md
- hugo/content/blog/hugo-vs-jekyll-benchmark.md
- hugo/content/blog/master-image-delivery-with-cloudinary.md
- hugo/content/blog/hugo-vs-jekyll-benchmark.md
- hugo/content/blog/test.md
- hugo/content/blog/what-s-new-in-jekyll-3.8.md
- hugo/content/careers/admin.md
- hugo/content/blog/join-our-slack-community.md
- hugo/content/blog/hugo-and-jekyll-compared.md
- hugo/content/blog/choose-static.md
- hugo/content/blog/instant-production-ready-scaffolding-with-create-static-site.md
- hugo/content/blog/landing-page-create-static-site-copy.md
- hugo/content/blog/why-we-built-forestry.md
- hugo/content/terms.md
- hugo/content/blog/bigger-better-editor.md
- hugo/content/blog/front-matter-templates.md
- hugo/content/blog/discontinuing-zip-sites.md
- hugo/content/blog/search-with-algolia-in-jekyll.md
- hugo/content/blog/what-s-new-in-jekyll-3-4-0.md
- hugo/content/careers/full-stack.md
- hugo/content/careers/software-engineer.md
- hugo/content/blog/sawmill-layout-composer-for-hugo-and-forestry.md
- hugo/content/blog/search-with-algolia-in-hugo.md
- hugo/content/blog/up-and-running-with-hugo.md
- hugo/content/blog/up-and-running-with-hugo-part-2.md
- hugo/content/blog/_index.md
- hugo/content/blog/discontinuing-wysiwyg-editor-new-focus-on-markdown.md
- hugo/content/blog/march-27th-service-outage.md
- hugo/content/blog/the-new-forestry-io.md
- hugo/content/blog/3-tips-for-mastering-blocks.md
- hugo/content/blog/forestryio-techstars-2016.md
- hugo/content/blog/wysiwyg-formatting-in-front-matter.md
- hugo/content/blog/big-improvements-to-front-matter-templates.md
- hugo/content/blog/why-we-created-a-git-backed-content-manager.md
- hugo/content/docs/faqs
- hugo/content/docs/git-sync
- hugo/content/docs/troubleshooting
- hugo/content/docs/_index.md
- hugo/content/blog/snippets-custom-content-sections-and-more.md
- hugo/content/blog/build-a-json-api-with-hugo.md
- hugo/content/blog/harness-the-power-of-static-to-create-presentations.md
- hugo/content/blog/vuepress-brings-your-documentation-to-life.md
- hugo/content/blog/block-labels-read-only-docs-and-more.md
- hugo/content/blog/automate-your-static-hosting-environment-with-aws-cloudformation.md
- hugo/content/blog/customize-sidebar-and-assign-front-matter-templates.md
- hugo/content/blog/creating-a-multilingual-blog-with-jekyll.md
- hugo/content/blog/cloudinary-integration.md
- hugo/content/blog/introducing-forestry-config-files.md
- hugo/content/blog/forestry-gitlab.md
- hugo/content/blog/renaming-files-and-improving-team-editing.md
- hugo/content/blog/migrating-to-key-based-authentication.md
- hugo/content/blog/building-a-company-component-library.md
- hugo/content/blog/for-static-sites-theres-no-excuse-not-to-use-a-cdn.md
- hugo/content/blog/5-ways-to-handle-forms-on-your-static-site.md
- hugo/content/blog/vuepress-support-beta.md
- hugo/content/blog/layout-improvements.md
- hugo/content/blog/introducing-media-management.md
- hugo/content/blog/improved-collaboration-and-more.md
- hugo/content/blog/custom-configuration-for-data-files.md
- hugo/content/blog/adding-dns-and-edge-functions-to-our-cloudformation-stack.md
- hugo/content/blog/5-options-for-automating-your-software-deployments.md
- hugo/content/blog/create-in-app-documentation-for-content-editors.md
- hugo/content/blog/Introducing-Custom-Build-Commands.md
- hugo/content/blog/Using-JSON-Configuration-With-VuePress.md
- hugo/content/blog/demystifying-hugo-conditionals.md
- hugo/content/blog/form-builder-with-formspree-forestry-blocks.md
- hugo/content/blog/ubuild-a-new-theme-for-static-sites-using-blocks.md
- hugo/content/blog/an-introduction-to-theming-in-vuepress.md
- hugo/content/blog/data-files-directories-and-duplicating-pages.md
- hugo/content/blog/new-improve-media-gallery.md
- hugo/content/blog/spike-test-reset.md
- hugo/content/blog/better-content-management-for-gatsby.md
- hugo/content/blog/is-it-time-to-move-on-from-wordpress.md
- hugo/content/asdd.md
- hugo/content/blog/forestry-git-backed-content-management-for-gatsby.md
- hugo/content/careers/hiring-technical-support.md
- hugo/content/blog/how-i-reduced-my-jekyll-build-time-by-61.md
- hugo/content/blog/add-functionality-to-your-hugo-site-with-theme-components.md
- hugo/content/blog/data-relationships-in-hugo.md
- hugo/content/blog/a-hugo-update-everyone-should-be-talking-about.md
- hugo/content/blog/how-to-use-hugo-s-image-processing-with-forestry.md
- hugo/content/blog/ftp-an-outdated-deployment-method-for-static-sites.md
- hugo/content/blog/new-pricing-organization-accounts.md
- hugo/content/blog/3-patterns-for-loading-data-with-react.md
- hugo/content/careers/hiring-devops-engineer.md
- hugo/content/careers/devrel.md
- hugo/content/careers/hiring-a-senior-ruby-developer.md
- hugo/content/careers/marketing.md
- hugo/content/careers/user-experience-ux-researcher.md
- hugo/content/blog/statyc-a-luxury-festival-for-hackers.md
- hugo/content/blog/hugo-support-sorting-for-pages-and-more.md
- hugo/content/careers/developer-evangelist.md
- hugo/content/blog/full-speed-ahead-in-2019.md
- hugo/content/blog/what-are-instant-previews.md
- hugo/content/blog/versioning-large-files-with-git-lfs.md
- hugo/content/careers/_index.md
- hugo/content/careers/developer-evangelist-1.md
- hugo/content/blog/gulp-and-webpack-best-of-both-worlds.md
2 changes: 1 addition & 1 deletion hugo/.forestry/front_matter/templates/doc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -129,5 +129,5 @@ fields:
default: single
hidden: true
pages:
- hugo/content/docs/settings/snippets.md
- hugo/content/docs/troubleshooting/unexpected-status-code-connection-expected-but-not-available.md
- hugo/content/docs/settings/snippets.md
6 changes: 3 additions & 3 deletions hugo/.forestry/front_matter/templates/landing-page.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ fields:
hidden: true
default: blocks
pages:
- hugo/content/blocks.md
- hugo/content/test-landing-page.md
- hugo/content/landing-page-test.md
- hugo/content/another-landing-page.md
- hugo/content/landing-page-test.md
- hugo/content/test-landing-page.md
- hugo/content/blocks.md
8 changes: 4 additions & 4 deletions hugo/.forestry/front_matter/templates/showcase-item.yml
Original file line number Diff line number Diff line change
Expand Up @@ -125,8 +125,8 @@ fields:
source:
type: datafiles
pages:
- hugo/content/showcase/yieldmo.md
- hugo/content/showcase/developerecosystem.md
- hugo/content/showcase/smallmultiples.md
- hugo/content/showcase/_index.md
- hugo/content/showcase/borisfx.md
- hugo/content/showcase/_index.md
- hugo/content/showcase/smallmultiples.md
- hugo/content/showcase/developerecosystem.md
- hugo/content/showcase/yieldmo.md
27 changes: 14 additions & 13 deletions hugo/content/docs/settings/fields/blocks.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,24 @@ expirydate: 2030-01-01 00:00:00 +0000
date: 2018-04-23 00:00:00 +0000
---

The **Blocks** field type is a repeatable array of field groups. Unlike the [Repeatable Field Group](/docs/settings/fields/repeatable-field-group), however, the field groups within a Blocks field do not all have to be the same.

## Options
![Blocks field options](/uploads/2018/04/blocks-field-ui.png)
{{% pretty_screenshot img="/uploads/2018/04/blocks-content-ui.png" %}}

- *Label* — the human-friendly label shown above the input field in the editor
- *Name* — the key stored in your content's front matter, used to access it in your templates
- *Description* — a human-friendly description of what the field does and/or instructions for your editors
- *Hidden* — hides the field in the editor; but allows developers to set default values or maintain the field for legacy purposes.
- *Templates* — select one or more [Front Matter Templates](/docs/settings/front-matter-templates/) that can be added to the Blocks field.
The **Blocks** field type is a repeatable array of field groups. Unlike the [Repeatable Field Group](/docs/settings/fields/repeatable-field-group), however, the field groups within a Blocks field do not all have to be the same.

## Field UI
![Blocks content interface](/uploads/2018/04/blocks-content-ui.png)
When a user adds a block, they first select which type of block they wish to add. Blocks can be reordered in the UI by dragging and dropping.

Before adding a block, the user selects which type of block they wish to add.
## Options

Blocks can be reordered in the UI by dragging and dropping.
- **General**
- *Label* — the human-friendly label shown above the input field in the editor
- *Name* — the key stored in your content's front matter, used to access it in your templates
- *Description* — a human-friendly description of what the field does and/or instructions for your editors
- *Hidden* — hides the field in the editor; but allows developers to set default values or maintain the field for legacy purposes.
- **Blocks**
- *Templates* — select one or more [Front Matter Templates](/docs/settings/front-matter-templates/) that can be added to the Blocks field.
- **Validation**
- *Minimum* — The minimum number of blocks that must be added to the field.
- *Maxiumum* — The maximum number of blocks allowed for the field.

## Templating

Expand Down
23 changes: 12 additions & 11 deletions hugo/content/docs/settings/fields/color-picker.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,23 @@ expirydate: 2030-01-01 04:00:00 +0000
date: 2018-05-29 00:00:00 -0400
---

{{% pretty_screenshot img="/uploads/2018/05/colorpicker-field-ui.png" %}}

The color picker provides an interface for selecting a color and storing the RGB or hex value.

## Options

![Color picker field options](/uploads/2018/05/colorpicker-field-options.png)

* _Label_the human-friendly label shown above the input field in the editor.
* _Name_ – the key stored in your content’s front matter, used to access it in your templates.
* _Description_ – a human friendly description of what the field does and/or instructions for your editors.
* _Hidden_ – hides the field in the editor, but allows developers to set default values or maintain the field for legacy purposes.
* _Required_ – prevent changes from being saved if this field is empty.
* _Color Format_ – Whether to save the RGB or hex value of the selected color.

## Field UI
- **General**
- _Label_ — the human-friendly label shown above the input field in the editor.
- _Name_ — the key stored in your content’s front matter, used to access it in your templates.
- _Description_ — a human friendly description of what the field does and/or instructions for your editors.
- _Hidden_ — hides the field in the editor, but allows developers to set default values or maintain the field for legacy purposes.
- **Format**
- _Color Format_ — Whether to save the RGB or hex value of the selected color.
- **Validation**
- _Required_ – prevent changes from being saved if this field is empty.
- **Default** — supply a default color value.

![Color picker field UI](/uploads/2018/05/colorpicker-field-ui.png)

## Templating

Expand Down
Loading

0 comments on commit 84c46cd

Please sign in to comment.