diff --git a/docs/next-env.d.ts b/docs/next-env.d.ts index f87ea7fa66a..6ab0ecc22f4 100644 --- a/docs/next-env.d.ts +++ b/docs/next-env.d.ts @@ -2,3 +2,6 @@ /// /// /// + +// NOTE: This file should not be edited +// see https://nextjs.org/docs/basic-features/typescript for more information. diff --git a/docs/pages/releases/2021-08-17.mdx b/docs/pages/releases/2021-08-17.mdx new file mode 100644 index 00000000000..1a5b5a3bfca --- /dev/null +++ b/docs/pages/releases/2021-08-17.mdx @@ -0,0 +1,74 @@ +import { Markdown, getStaticProps } from '../../components/Markdown'; +import { Emoji } from '../../components/primitives/Emoji'; + +# Release: 17th August 2021 + +A major milestone in the path to a `General Availability` status for **Keystone 6**, this release includes: + +- **A new and improved GraphQL API** +- Enhancements to Custom Admin UI Pages +- Better deletion notifications +- And more… + +**⚠️   This release contains breaking changes, please see below!** + +```json +"@keystone-ui/notice": "4.0.1", +"@keystone-ui/segmented-control": "4.0.2", +"@keystone-ui/toast": "4.0.2", +"@keystone-next/admin-ui-utils": "5.0.6", +"@keystone-next/auth": "31.0.0", +"@keystone-next/cloudinary": "6.0.6", +"@keystone-next/fields": "14.0.0", +"@keystone-next/fields-document": "8.0.0", +"@keystone-next/keystone": "24.0.0", +"@keystone-next/testing": "1.1.1", +"@keystone-next/types": "24.0.0", +"@keystone-next/utils": "1.0.4", +``` + +## A new & improved GraphQL API + +We’ve made the experience of working with Keystone’s GraphQL API easier to program and reason about: + +- **Queries:** the names of top-level queries are now easier to understand. We also removed deprecated and unused legacy features. +- **Filters:** the arguments used in queries have been updated to accept a filter object for each field, rather than having all the filter options available at the top level. +- **Mutations:** all generated CRUD mutations have the same names and return types, but their inputs have changed. +- **Input Types:** we’ve updated the input types used for relationship fields in `update` and `create` operations, removing obsolete options and making the syntax between the two operations easier to differentiate. + +#### Upgrade guidance + +We've [written a complete guide](https://keystonejs.com/updates/new-graphql-api) to the improvements we've made, and it includes [a checklist of the steps you need to take to upgrade your Keystone projects](https://keystonejs.com/updates/new-graphql-api#upgrade-checklist). Be sure to check it out! + +!> While there are a lot of changes to this API, if you approach the upgrade process systematically your experience should be pretty smooth. If you get stuck or have questions, reach out to us in the [Keystone community slack](https://community.keystonejs.com) to get the help you need. + +Screen Shot 2021-08-17 at 11 28 56 am + +## Custom Admin UI Pages + +Our [Custom Admin UI Pages](https://keystonejs.com/docs/guides/custom-admin-ui-pages) guide has been expanded, with an example to make your custom pages look more like the Admin UI, as well as adding links to your custom pages from the Admin UI Navigation! + +Screen Shot 2021-08-17 at 11 30 39 am + +## Improved Deletion Notifications + +When items are deleted via the Admin UI, we now display all the items that were successfully deleted, and any that failed, instead of displaying multiple notifications without any context. + +Screen Shot 2021-08-17 at 11 04 47 am + +## Deeper GraphQL Errors + +A `config.graphql.debug` option has been added, which can be used to control whether debug information such as stack traces are included in the errors returned by the GraphQL API. + +## Prisma Update + +Updated Prisma dependencies from `2.27.0` to `2.29.0`, check out the [Prisma releases page](https://github.com/prisma/prisma/releases/tag/2.29.0) for more details. + +## Credits + +Added option for `Bearer` token auth when using session, thanks to [@gautamsi](https://github.com/gautamsi)! + +You can also view the [verbose release notes](https://github.com/keystonejs/keystone/releases/tag/2021-08-17) on GitHub. + +export default ({ children, ...props }) => {children}; +export { getStaticProps } diff --git a/docs/pages/releases/index.mdx b/docs/pages/releases/index.mdx index 538727144f1..911bcd49c02 100644 --- a/docs/pages/releases/index.mdx +++ b/docs/pages/releases/index.mdx @@ -4,75 +4,79 @@ import { Status } from '../../components/primitives/Status'; # Release Notes -## 29th July 2021 +## 17th August 2021 -Custom **navigation**, **pages** and **logo** in this big **Admin UI** themed release! β€” [read more](/releases/2021-07-29) +A **major milestone** in the path to a General Availability status for Keystone 6 this release includes ** new and improved GraphQL API** and more. β€” [Read more](/releases/2021-08-17) + +## 29th July 2021 + +Custom **navigation**, **pages** and **logo** in this big **Admin UI** themed release! β€” [Read more](/releases/2021-07-29) ## 13th July 2021 -More examples, types, and UI rendering tweaks as we push forward towards a general availability release! β€” [read more](/releases/2021-07-13) +More examples, types, and UI rendering tweaks as we push forward towards a general availability release! β€” [Read more](/releases/2021-07-13) ## 30th June 2021 -We fixed an issue with `cloudinaryImage` and `relationship` fields. β€” [read more](/releases/2021-06-30) +We fixed an issue with `cloudinaryImage` and `relationship` fields. β€” [Read more](/releases/2021-06-30) ## 29th June 2021 -The ID Field option has been revamped with `cuid`, `uuid` and `autoincrement` options! β€” [read more](/releases/2021-06-29) +The ID Field option has been revamped with `cuid`, `uuid` and `autoincrement` options! β€” [Read more](/releases/2021-06-29) ## 28th June 2021 -A new package to help test the behaviour of your GraphQL API, a document field example, better error messages, accessibility updates and another Prisma update! β€” [read more](/releases/2021-06-28) +A new package to help test the behaviour of your GraphQL API, a document field example, better error messages, accessibility updates and another Prisma update! β€” [Read more](/releases/2021-06-28) ## 15th June 2021 -Keystone Next now has a new core , unblocking many of the features you’ve been waiting for! β€” [read more](/releases/2021-06-15) +Keystone Next now has a new core , unblocking many of the features you’ve been waiting for! β€” [Read more](/releases/2021-06-15) ## 2nd June 2021 -We have a new JSON field , a bunch of new learning resources, and plenty of under the hood optimisations in this big release. β€” [read more](/releases/2021-06-02) +We have a new JSON field , a bunch of new learning resources, and plenty of under the hood optimisations in this big release. β€” [Read more](/releases/2021-06-02) ## 19th May 2021 -Node updates and Admin UI has moved! β€” [read more](/releases/2021-05-19) +Node updates and Admin UI has moved! β€” [Read more](/releases/2021-05-19) ## 17th May 2021 -Apollo caching can now be configured for performance and a basic authentication example to get your started β€” [read more](/releases/2021-05-17) +Apollo caching can now be configured for performance and a basic authentication example to get your started β€” [Read more](/releases/2021-05-17) ## 11th May 2021 -A bunch of admin UI tweaks in this release , among other minor fixes β€” [read more](/releases/2021-05-11) +A bunch of admin UI tweaks in this release , among other minor fixes β€” [Read more](/releases/2021-05-11) ## 5th May 2021 -Aside from dependency updates , we added an `isIndexed` config option to the `text`, `integer`, `float`, `select`, and `timestamp` field types β€” [read more](/releases/2021-05-05) +Aside from dependency updates , we added an `isIndexed` config option to the `text`, `integer`, `float`, `select`, and `timestamp` field types β€” [Read more](/releases/2021-05-05) ## 3rd May 2021 -Files in Keystone Next ! This release involved a bunch of busywork behind the scenes in Keystone Next β€” [read more](/releases/2021-05-03) +Files in Keystone Next ! This release involved a bunch of busywork behind the scenes in Keystone Next β€” [Read more](/releases/2021-05-03) ## 20th April 2021 -Improvements to the Lists API, deprecating `resolveFields` β€” [read more](/releases/2021-04-20) +Improvements to the Lists API, deprecating `resolveFields` β€” [Read more](/releases/2021-04-20) ## 6th April 2021 -Controlled code demolition , Better pagination in Admin UI β€” [read more](/releases/2021-04-06) +Controlled code demolition , Better pagination in Admin UI β€” [Read more](/releases/2021-04-06) ## 30th March 2021 -Goodbye legacy code , Improved `select` field type , Squashed bugs β€” [read more](/releases/2021-03-30) +Goodbye legacy code , Improved `select` field type , Squashed bugs β€” [Read more](/releases/2021-03-30) ## 23rd March 2021 -Added support for SQLite with Prisma , Noteworthy bug-squashing β€” [read more](/releases/2021-03-23) +Added support for SQLite with Prisma , Noteworthy bug-squashing β€” [Read more](/releases/2021-03-23) ## 22nd March 2021 -Prisma migrations , Noteworthy bug-squashing β€” [read more](/releases/2021-03-22) +Prisma migrations , Noteworthy bug-squashing β€” [Read more](/releases/2021-03-22)
diff --git a/docs/pages/updates/index.tsx b/docs/pages/updates/index.tsx index 92518a0fdd8..8c004183f9c 100644 --- a/docs/pages/updates/index.tsx +++ b/docs/pages/updates/index.tsx @@ -10,6 +10,7 @@ import { Alert } from '../../components/primitives/Alert'; import { Type } from '../../components/primitives/Type'; import { DocsPage } from '../../components/Page'; import { ArrowR } from '../../components/icons/ArrowR'; +import { Emoji } from '../../components/primitives/Emoji'; import { useMediaQuery } from '../../lib/media'; type TimelineProps = { @@ -165,7 +166,26 @@ export default function WhatsNew() { gap: 0, })} > - + + + A major milestone in the path to a General Availability status + for Keystone 6, we've just released a new and improved GraphQL API.{' '} + +
+
+ We’ve made the experience of working with Keystone’s GraphQL API easier to program and + reason about: We've{' '} + written a complete guide to + the improvements we've made, and it includes a{' '} + + checklist of the steps you need to take to upgrade your Keystone projects + + . +
+
+ Be sure to check it out! +
+ We're opening Admin UI up to support a more personal content experience. Now you can: