Skip to content

Conversation

@pwizla
Copy link
Collaborator

@pwizla pwizla commented Aug 2, 2022

This PR will be a recipient to merge all of the new content for Custom Fields (both user guide and developer docs):

It will include the following PRs:

⚠️ Don't merge it until ready & approved as it would auto-deploy the content to docs-next.strapi.io

@vercel
Copy link

vercel bot commented Aug 2, 2022

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
documentation ✅ Ready (Inspect) Visit Preview Aug 25, 2022 at 0:44AM (UTC)

@pwizla pwizla self-assigned this Aug 2, 2022
@pwizla pwizla added source: Dev Docs PRs/issues targeting the Developer Docs source: User Guide PRs/issues targeting the User Guide pr: updated content PRs updating existing documentation content pr: new content PRs for new product features or new documentation sections target: v4 Documentation PRs/issues targeting content from docs.strapi.io (main branch). target: next Documentation PRs/issues targeting content from docs-next.strapi.io (next branch) size: large If the PR includes 1+ file(s) with a total of 50+ lines of text or 100+ lines of code labels Aug 2, 2022
@pwizla pwizla added this to the 4.4.0-alpha milestone Aug 2, 2022
@pwizla pwizla added the internal PRs created by the Strapi core team label Aug 5, 2022
@pwizla pwizla added the flag: don't merge This PR should not be merged at the moment label Aug 10, 2022
pwizla and others added 2 commits August 24, 2022 18:23
* Keep old version number for now

* Fix rendering issue caused by missing blank line after code block

* [WIP] Custom Fields: Updates to Content-Type Builder documentation (#1018)

* Add custom fields h2

* Replace field selection screenshot

* Update "Configuring fields for content-types"

* Add TODO for possible "managing custom fields" content

* Reword marketplace mention and fix link

* Fix rendering issue caused by missing blank line after code block

* Delete deprecated comments

* Mention custom fields in the Content Manager (#1051)

* Update version number

* Delete TODO as link now works

* Mention custom fields in plugins introduction

* Mention that custom fields can also be added to components

* Update "Installing plugins via Marketplace" with custom fields

* Mention custom fields in Global settings

* Clean up completed TODOs

* Exclude non-related content

* Fix email closing (not-related to CF)

* Update wording (removing "all")

* Treat custom fields as part of plugins

* Update description for "other plugins" settings

* Revert screenshot change

No custom fields tab in in-app Marketplace

* Remove unused screenshot for "custom fields" settings

* Fix what → which

Co-authored-by: Shaun Brown  <97027841+StrapiShaun@users.noreply.github.com>

* Fix: filling up → filling out

* Update built-in → pre-installed

Co-authored-by: Shaun Brown  <97027841+StrapiShaun@users.noreply.github.com>
* Add custom fields to TOC

* Fix unclosed array in TOC config

* Prepare TOC for upcoming content

* Custom fields - Dev docs: Add a new Development > Custom Fields page (#1035)

* WIP

* Add WIP reference and example guide for custom fields

* Delete old file, now splitted into reference and guide

* Improve reference guide

* Add first draft of color picker custom fields guide

* Improve reference documentation

* Improve example guide

* Mention custom fields in plugins development

* Fix TOC casing

* Remove tutorial and update sidebar and "main" doc file name

* Temporarily remove callout for tutorial

* Improve custom fields reference documentation

* Further improve custom fields reference documentation

* Update first note with a mention to app-specific custom fields

* Add prerequisites (plugin)

* Update `items` table

* Add multimarkdown support + prepare for documenting all settings fields

* Improve introduction

* Improve `plugin` key description

* Delete deprecated TODOs

* Fix paths in example code

* Update wording: settings → options

* Improve `options` table

* Update prerequisites to also mention enabling plugin

* Remove callout from plugins dev, will be moved to another PR

* Reword introduction sentence

Co-authored-by: markkaylor <mark.kaylor@strapi.io>

* Reword models attributes intro. description

Co-authored-by: markkaylor <mark.kaylor@strapi.io>

* Fix preposition and singular usage

Co-authored-by: markkaylor <mark.kaylor@strapi.io>

* Update text → string in color picker example

* Mention `media` can't be used as a data type

* Add `media` to the list of forbidden data types

* Update validator code example

Co-authored-by: markkaylor <mark.kaylor@strapi.io>

* Remove question comment about inline components

* Update string → text

* Remove View component

* Finish removing View component and update "Components" section

* Improve mention of non-usable data types

* Remove bootstrap() and mention src/admin/app.s

* Add link to user guide + mention CF can be added to components

* Remove some comments

* Replace bootstrap() with register()

* Mention yup

* Improve settings items description

* Remove note about not being able to import custom input components

* Improve `options` description and code example

* Fix user guide link (no #)

* Update schema.json → schema

* Remove non-relevant TODO

* Update strapi code base links

* Don't mention what happens if `plugin` is omitted in server

* Simplify callouts

* Fix CTB spelling

Co-authored-by: Shaun Brown  <97027841+StrapiShaun@users.noreply.github.com>

* Move note about forbidden data types into the table

* Fix 'can not' → 'cannot'

* Fix: can't → cannot

* Add tip for `Input` component props

Co-authored-by: markkaylor <mark.kaylor@strapi.io>
Co-authored-by: Shaun Brown  <97027841+StrapiShaun@users.noreply.github.com>

* Custom fields - Dev docs: Updates to Backend customization > Models (#1052)

* Add a few draft lines about impact on models

* Add custom fields section to models attributes docs

* Add custom fields to the list of types availables in schema.json

* Fix typo in customField parameter name

* Replace `custom field` by `customField` in table

* Fix uid for global field name

* Fix gerundive

Co-authored-by: Shaun Brown  <97027841+StrapiShaun@users.noreply.github.com>

* Improve description of plugin/global uids

* Fix duplicate content

Co-authored-by: Shaun Brown  <97027841+StrapiShaun@users.noreply.github.com>

* Custom fields - Dev docs: Minor updates and cross-links (#1053)

* Mention custom fields in server and admin panel APIs for plugins

* Mention custom fields in plugins development

* Mention custom fields in the global register() and bootstrap() methods

* Register a custom field in admin with register(), not bootstrap()

* Add registering admin panel part of a CF to available actions

* Fix: custom fields are registered in register(), not bootstrap()

* Improve intro. sentence for bootstrap()

Co-authored-by: markkaylor <mark.kaylor@strapi.io>
Co-authored-by: Shaun Brown  <97027841+StrapiShaun@users.noreply.github.com>
@pwizla pwizla changed the title [WIP] Custom Fields Custom Fields Aug 24, 2022
@pwizla pwizla marked this pull request as ready for review August 24, 2022 16:25
@pwizla pwizla removed the flag: don't merge This PR should not be merged at the moment label Aug 25, 2022
@pwizla pwizla merged commit 0ea50df into next Aug 25, 2022
@pwizla pwizla deleted the repo/custom-fields branch August 25, 2022 12:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal PRs created by the Strapi core team pr: new content PRs for new product features or new documentation sections pr: updated content PRs updating existing documentation content size: large If the PR includes 1+ file(s) with a total of 50+ lines of text or 100+ lines of code source: Dev Docs PRs/issues targeting the Developer Docs source: User Guide PRs/issues targeting the User Guide target: next Documentation PRs/issues targeting content from docs-next.strapi.io (next branch) target: v4 Documentation PRs/issues targeting content from docs.strapi.io (main branch).

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant