From 57e57936c3879b320aa248c200814d5186f970ec Mon Sep 17 00:00:00 2001 From: Gabin Aureche Date: Sun, 22 Nov 2020 20:12:55 +0100 Subject: [PATCH 01/15] [docs] Fix material-ui broken link (#2929) The link "With React UI Frameworks" / "Material UI" is currently broken. I noticed that the page it points to is in the examples. Since it's a duplicate, I chose to remove it. But let me know if you'd prefer to keep it and fix the URL. For the record, it's currently pointing to: https://formik.org/docs/with-react-ui-frameworks/with-material-ui while the page is there: https://formik.org/docs/examples/with-material-ui --- docs/src/manifests/manifest.json | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/docs/src/manifests/manifest.json b/docs/src/manifests/manifest.json index 88e4cce3f..7b248fdd4 100644 --- a/docs/src/manifests/manifest.json +++ b/docs/src/manifests/manifest.json @@ -50,16 +50,6 @@ } ] }, - { - "title": "With React UI Frameworks", - "open": false, - "routes": [ - { - "title": "Material UI", - "path": "/docs/with-react-ui-frameworks/with-material-ui.md" - } - ] - }, { "title": "Examples", "open": true, From c876b31fc90954d19cb8fd3c676c02754c265661 Mon Sep 17 00:00:00 2001 From: Jared Palmer Date: Wed, 25 Nov 2020 11:21:42 -0500 Subject: [PATCH 02/15] Update FUNDING.yml --- .github/FUNDING.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml index f23bdfe0a..d06d1d737 100644 --- a/.github/FUNDING.yml +++ b/.github/FUNDING.yml @@ -1,6 +1,6 @@ # These are supported funding model platforms -github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] +github: [jaredpalmer] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] patreon: # Replace with a single Patreon username open_collective: formik ko_fi: # Replace with a single Ko-fi username From 58c12770aa20809455d79c0defdb99a462c1eb71 Mon Sep 17 00:00:00 2001 From: Jared Palmer Date: Wed, 2 Dec 2020 11:37:34 -0500 Subject: [PATCH 03/15] Update issue templates --- .github/ISSUE_TEMPLATE/---feature-request.md | 36 ++++++++ .github/ISSUE_TEMPLATE/Bug_report.md | 90 ++++++++++---------- .github/ISSUE_TEMPLATE/Documentation.md | 4 + .github/ISSUE_TEMPLATE/Feature_request.md | 68 ++++++++------- .github/ISSUE_TEMPLATE/Question.md | 8 -- .github/ISSUE_TEMPLATE/bug-report.md | 47 ++++++++++ .github/ISSUE_TEMPLATE/feature-request.md | 36 ++++++++ 7 files changed, 206 insertions(+), 83 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/---feature-request.md delete mode 100644 .github/ISSUE_TEMPLATE/Question.md create mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.md diff --git a/.github/ISSUE_TEMPLATE/---feature-request.md b/.github/ISSUE_TEMPLATE/---feature-request.md new file mode 100644 index 000000000..310ab8849 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/---feature-request.md @@ -0,0 +1,36 @@ +--- +name: "\U0001F680 Feature request" +about: Suggest an idea for Formik +title: '' +labels: 'Type: Feature Request' +assignees: '' + +--- + +## πŸš€ Feature request + +### Current Behavior + + + +### Desired Behavior + + + +### Suggested Solution + + + + + +### Who does this impact? Who is this for? + + + +### Describe alternatives you've considered + + + +### Additional context + + diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md index f761a257b..6e0be2e56 100644 --- a/.github/ISSUE_TEMPLATE/Bug_report.md +++ b/.github/ISSUE_TEMPLATE/Bug_report.md @@ -1,43 +1,47 @@ ---- -name: "\U0001F41B Bug report" -about: Create a report to help make Formik better ---- - -## πŸ› Bug report - -### Current Behavior - - - -### Expected behavior - - - -### Reproducible example - - - - - - - -### Suggested solution(s) - - - -### Additional context - - - -### Your environment - - - -| Software | Version(s) | -| ---------------- | ---------- | -| Formik | -| React | -| TypeScript | -| Browser | -| npm/Yarn | -| Operating System | +--- +name: "\U0001F41B Bug report" +about: Create a report to help make Formik better +title: '' +labels: '' +assignees: '' + +--- + +## πŸ› Bug report + +### Current Behavior + + + +### Expected behavior + + + +### Reproducible example + + + + + + + +### Suggested solution(s) + + + +### Additional context + + + +### Your environment + + + +| Software | Version(s) | +| ---------------- | ---------- | +| Formik | +| React | +| TypeScript | +| Browser | +| npm/Yarn | +| Operating System | diff --git a/.github/ISSUE_TEMPLATE/Documentation.md b/.github/ISSUE_TEMPLATE/Documentation.md index 4b5403327..899841102 100644 --- a/.github/ISSUE_TEMPLATE/Documentation.md +++ b/.github/ISSUE_TEMPLATE/Documentation.md @@ -1,6 +1,10 @@ --- name: "\U0001F41B Documentation" about: Imrovements or suggestions of Formik documentation +title: '' +labels: '' +assignees: '' + --- ## πŸ“– Documentation diff --git a/.github/ISSUE_TEMPLATE/Feature_request.md b/.github/ISSUE_TEMPLATE/Feature_request.md index 61f7e1e0c..ac8dca782 100644 --- a/.github/ISSUE_TEMPLATE/Feature_request.md +++ b/.github/ISSUE_TEMPLATE/Feature_request.md @@ -1,32 +1,36 @@ ---- -name: "\U0001F680Feature request" -about: Suggest an idea for Formik ---- - -## πŸš€ Feature request - -### Current Behavior - - - -### Desired Behavior - - - -### Suggested Solution - - - - - -### Who does this impact? Who is this for? - - - -### Describe alternatives you've considered - - - -### Additional context - - +--- +name: "\U0001F680Feature request" +about: Suggest an idea for Formik +title: '' +labels: '' +assignees: '' + +--- + +## πŸš€ Feature request + +### Current Behavior + + + +### Desired Behavior + + + +### Suggested Solution + + + + + +### Who does this impact? Who is this for? + + + +### Describe alternatives you've considered + + + +### Additional context + + diff --git a/.github/ISSUE_TEMPLATE/Question.md b/.github/ISSUE_TEMPLATE/Question.md deleted file mode 100644 index ed1e99fc3..000000000 --- a/.github/ISSUE_TEMPLATE/Question.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -name: '❓Question' -about: 'Have a question? Checkout GitHub Discussions or the #formik channel on Formium Discord server' ---- - -## ❓Question - -Seriously, for immediate help, just ask your question on the #formik channel on [Formium](https://discordapp.com/invite/MbKwYuq). diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 000000000..3f32b86cd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,47 @@ +--- +name: Bug report +about: Create a bug report for Formik / examples +title: '' +labels: 'Type: Bug' +assignees: '' + +--- + +## Bug report + +### Current Behavior + + + +### Expected behavior + + + +### Reproducible example + + + + + + + +### Suggested solution(s) + + + +### Additional context + + + +### Your environment + + + +| Software | Version(s) | +| ---------------- | ---------- | +| Formik | +| React | +| TypeScript | +| Browser | +| npm/Yarn | +| Operating System | diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md new file mode 100644 index 000000000..57e75970e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,36 @@ +--- +name: Feature request +about: Request a new feature for Formik +title: '' +labels: 'Type: Feature Request' +assignees: '' + +--- + +## Feature request + +### Current Behavior + + + +### Desired Behavior + + + +### Suggested Solution + + + + + +### Who does this impact? Who is this for? + + + +### Describe alternatives you've considered + + + +### Additional context + + From 92a2b28328ee78db9e4404b204591fa9f0eb8968 Mon Sep 17 00:00:00 2001 From: Jared Palmer Date: Wed, 2 Dec 2020 11:41:33 -0500 Subject: [PATCH 04/15] Fix issue templates --- .github/ISSUE_TEMPLATE/---feature-request.md | 36 -------------- .../{bug-report.md => 1.Bug-report.md} | 1 - ...eature-request.md => 2.Feature-request.md} | 1 - .github/ISSUE_TEMPLATE/Bug_report.md | 47 ------------------- .github/ISSUE_TEMPLATE/Documentation.md | 10 ---- .github/ISSUE_TEMPLATE/Feature_request.md | 36 -------------- .github/ISSUE_TEMPLATE/config.yml | 5 ++ 7 files changed, 5 insertions(+), 131 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/---feature-request.md rename .github/ISSUE_TEMPLATE/{bug-report.md => 1.Bug-report.md} (99%) rename .github/ISSUE_TEMPLATE/{feature-request.md => 2.Feature-request.md} (99%) delete mode 100644 .github/ISSUE_TEMPLATE/Bug_report.md delete mode 100644 .github/ISSUE_TEMPLATE/Documentation.md delete mode 100644 .github/ISSUE_TEMPLATE/Feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/---feature-request.md b/.github/ISSUE_TEMPLATE/---feature-request.md deleted file mode 100644 index 310ab8849..000000000 --- a/.github/ISSUE_TEMPLATE/---feature-request.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -name: "\U0001F680 Feature request" -about: Suggest an idea for Formik -title: '' -labels: 'Type: Feature Request' -assignees: '' - ---- - -## πŸš€ Feature request - -### Current Behavior - - - -### Desired Behavior - - - -### Suggested Solution - - - - - -### Who does this impact? Who is this for? - - - -### Describe alternatives you've considered - - - -### Additional context - - diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/1.Bug-report.md similarity index 99% rename from .github/ISSUE_TEMPLATE/bug-report.md rename to .github/ISSUE_TEMPLATE/1.Bug-report.md index 3f32b86cd..72955f5a6 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/1.Bug-report.md @@ -4,7 +4,6 @@ about: Create a bug report for Formik / examples title: '' labels: 'Type: Bug' assignees: '' - --- ## Bug report diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/2.Feature-request.md similarity index 99% rename from .github/ISSUE_TEMPLATE/feature-request.md rename to .github/ISSUE_TEMPLATE/2.Feature-request.md index 57e75970e..86c53536b 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ b/.github/ISSUE_TEMPLATE/2.Feature-request.md @@ -4,7 +4,6 @@ about: Request a new feature for Formik title: '' labels: 'Type: Feature Request' assignees: '' - --- ## Feature request diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md deleted file mode 100644 index 6e0be2e56..000000000 --- a/.github/ISSUE_TEMPLATE/Bug_report.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -name: "\U0001F41B Bug report" -about: Create a report to help make Formik better -title: '' -labels: '' -assignees: '' - ---- - -## πŸ› Bug report - -### Current Behavior - - - -### Expected behavior - - - -### Reproducible example - - - - - - - -### Suggested solution(s) - - - -### Additional context - - - -### Your environment - - - -| Software | Version(s) | -| ---------------- | ---------- | -| Formik | -| React | -| TypeScript | -| Browser | -| npm/Yarn | -| Operating System | diff --git a/.github/ISSUE_TEMPLATE/Documentation.md b/.github/ISSUE_TEMPLATE/Documentation.md deleted file mode 100644 index 899841102..000000000 --- a/.github/ISSUE_TEMPLATE/Documentation.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -name: "\U0001F41B Documentation" -about: Imrovements or suggestions of Formik documentation -title: '' -labels: '' -assignees: '' - ---- - -## πŸ“– Documentation diff --git a/.github/ISSUE_TEMPLATE/Feature_request.md b/.github/ISSUE_TEMPLATE/Feature_request.md deleted file mode 100644 index ac8dca782..000000000 --- a/.github/ISSUE_TEMPLATE/Feature_request.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -name: "\U0001F680Feature request" -about: Suggest an idea for Formik -title: '' -labels: '' -assignees: '' - ---- - -## πŸš€ Feature request - -### Current Behavior - - - -### Desired Behavior - - - -### Suggested Solution - - - - - -### Who does this impact? Who is this for? - - - -### Describe alternatives you've considered - - - -### Additional context - - diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..f91ff6cf1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Ask a question + url: https://github.com/formium/formik/discussions + about: Ask questions and discuss with other community members From 19296099eccf6a42cce9b429996faad4682a20b4 Mon Sep 17 00:00:00 2001 From: Jared Palmer Date: Wed, 2 Dec 2020 11:44:47 -0500 Subject: [PATCH 05/15] Add discord to issue template --- .github/ISSUE_TEMPLATE/config.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index f91ff6cf1..24f6595c5 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -3,3 +3,6 @@ contact_links: - name: Ask a question url: https://github.com/formium/formik/discussions about: Ask questions and discuss with other community members + - name: Join the Discord server + url: https://discord.gg/pJSg287 + about: Chat with other community members in real-time From ccf7a2f99ccfd326e81dd0ea4216a0a862c14dbb Mon Sep 17 00:00:00 2001 From: Jared Palmer Date: Thu, 3 Dec 2020 10:34:06 -0500 Subject: [PATCH 06/15] Tweak seo on docs --- docs/src/lib/get-route-context.tsx | 6 +++--- docs/src/pages/docs/3rd-party-bindings.md | 1 + docs/src/pages/docs/examples.md | 1 + docs/src/pages/docs/migrating-v2.md | 1 + docs/src/pages/docs/overview.md | 1 + docs/src/pages/docs/resources.md | 1 + docs/src/pages/docs/tutorial.md | 1 + 7 files changed, 9 insertions(+), 3 deletions(-) diff --git a/docs/src/lib/get-route-context.tsx b/docs/src/lib/get-route-context.tsx index 69a629c42..f8dfe8480 100644 --- a/docs/src/lib/get-route-context.tsx +++ b/docs/src/lib/get-route-context.tsx @@ -39,7 +39,7 @@ export function getRouteContext( parent && i === 0 ? { ...route, - title: `${parent.title}: ${route.title}`, + title: `${_route.title} | ${parent.title}`, } : route; @@ -51,7 +51,7 @@ export function getRouteContext( ..._route, title: parent && !parent.heading - ? `${parent.title}: ${_route.title}` + ? `${_route.title} | ${parent.title}` : _route.title, }; // Continue the loop until we know the next route @@ -62,7 +62,7 @@ export function getRouteContext( parent && !parent.heading && !routes[i + 1]?.path ? { ...route, - title: `${parent.title}: ${route.title}`, + title: `${route.title} | ${parent.title}`, } : route; } diff --git a/docs/src/pages/docs/3rd-party-bindings.md b/docs/src/pages/docs/3rd-party-bindings.md index f0d45e741..d95bb375c 100644 --- a/docs/src/pages/docs/3rd-party-bindings.md +++ b/docs/src/pages/docs/3rd-party-bindings.md @@ -1,6 +1,7 @@ --- title: 3rd Party Bindings original_id: 3rd-party-bindings +description: Use Formik with popular React component libraries like Material UI, Bootstrap, AntD, Semantic UI, and more. --- If you would like to use Formik with a UI framework, you'll probably want to create a wrapper component that binds Formik's props and callbacks. diff --git a/docs/src/pages/docs/examples.md b/docs/src/pages/docs/examples.md index eb2656e63..39bb848e0 100644 --- a/docs/src/pages/docs/examples.md +++ b/docs/src/pages/docs/examples.md @@ -1,6 +1,7 @@ --- id: examples title: Examples +description: Runnable examples of using Formik in React and React Native to create forms --- ## Dependent Fields diff --git a/docs/src/pages/docs/migrating-v2.md b/docs/src/pages/docs/migrating-v2.md index 195f5edab..8b8d56201 100644 --- a/docs/src/pages/docs/migrating-v2.md +++ b/docs/src/pages/docs/migrating-v2.md @@ -1,6 +1,7 @@ --- id: migrating-v2 title: Migrating from v1.x to v2.x +description: How to migrate from Formik v1 to v2 --- ## Breaking Changes diff --git a/docs/src/pages/docs/overview.md b/docs/src/pages/docs/overview.md index ad824c2a6..412595233 100644 --- a/docs/src/pages/docs/overview.md +++ b/docs/src/pages/docs/overview.md @@ -1,6 +1,7 @@ --- id: overview title: Overview +description: Formik documentation, tutorial, guides, and examples --- Let's face it, forms are really verbose in diff --git a/docs/src/pages/docs/resources.md b/docs/src/pages/docs/resources.md index fbb864748..8978539ca 100644 --- a/docs/src/pages/docs/resources.md +++ b/docs/src/pages/docs/resources.md @@ -1,6 +1,7 @@ --- id: resources title: Resources +description: Formik conference talks, courses, videos, blog posts, learning resources. --- ## Conference Talks diff --git a/docs/src/pages/docs/tutorial.md b/docs/src/pages/docs/tutorial.md index fb46889a4..fd42a7740 100644 --- a/docs/src/pages/docs/tutorial.md +++ b/docs/src/pages/docs/tutorial.md @@ -1,6 +1,7 @@ --- id: tutorial title: Tutorial +description: Learn how to build forms in React with Formik. --- ## Before we start From cfb912b3331ebcd3afa53c5cf1e866b5138de734 Mon Sep 17 00:00:00 2001 From: Jared Palmer Date: Thu, 3 Dec 2020 10:36:51 -0500 Subject: [PATCH 07/15] Tweak seo --- docs/src/pages/blog/[...slug].tsx | 2 +- docs/src/pages/index.tsx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/src/pages/blog/[...slug].tsx b/docs/src/pages/blog/[...slug].tsx index 059e84a26..23c9f7b37 100644 --- a/docs/src/pages/blog/[...slug].tsx +++ b/docs/src/pages/blog/[...slug].tsx @@ -154,7 +154,7 @@ const RenderPost = ({ post, redirect, preview }: any) => {