forked from keystonejs/keystone
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
🚀 General Availability website copy changes (keystonejs#7000)
* docs: fix variable name on tutorial code example (keystonejs#6875) Replace use of "lists" from ".keystone/api" with "query" variable to make it works. * fixed remote links markup (keystonejs#6881) * Fixed some emoji descriptions for better accessibility (keystonejs#6882) * fixed some emoji descriptions * found another one * Fix incorrect db key in timestamp documentation (keystonejs#6883) /s/createdAt/updatedAt * Update for-content-management.tsx (keystonejs#6891) * minor fixes to context docs (keystonejs#6925) * minore fixes to context docs * change image.getSrc to image.getUrl in context docs * Release notes for 2021-11-15 (keystonejs#6933) * Progress commit. * Update 2021-11-15.mdx * Update 2021-11-15.mdx * Update 2021-11-15.mdx (keystonejs#6935) * Text tweaks to release notes. (keystonejs#6941) * Update 2021-11-15.mdx * Update 2021-11-15.mdx * Text updates. * remove preview badge from header * Add release announcement page * Edits to `updates` sidebar nav * Update announcement banner * Ks5 6 copy change (keystonejs#6973) * copy change to ks5vs6 guide to reflect GA release * more updates to the intro copy of the guide for ga purposes * Update docs/pages/updates/keystone-5-vs-keystone-6-preview.mdx Copy update from Ron 🙏 Co-authored-by: Ronald Aveling <ronald.aveling@thinkmill.com.au> * Update docs/pages/updates/keystone-5-vs-keystone-6-preview.mdx Co-authored-by: Ronald Aveling <ronald.aveling@thinkmill.com.au> Co-authored-by: Ronald Aveling <ronald.aveling@thinkmill.com.au> * Header fixes (keystonejs#6995) * search now always present, why keystone and updates now removed on lower breakpoints * augmented to use auto instead of max-content in grid-template to ensure searchbox does cause the layout to overflow * revert search input changes, since the result dialog is presently broken in mobile view * Update docs/components/Header.tsx Co-authored-by: Dominik Wilkowski <hi@dominik-wilkowski.com> Co-authored-by: Dominik Wilkowski <hi@dominik-wilkowski.com> * Initial GA content. * Progress commit for roadmap page. * Update roadmap.tsx * Update roadmap.tsx * Update Announce.tsx * added SVG to GA announcement * Adjusted SVG animation * Fixed URL typo * Added timeline items * Content improvements * Improvements to Roadmap page * Changes to style and content * Minor content changes * Fixed links and copy for 5 > 6 guide * Content updates to roadmap * CSS cleanup * Changed copy in GA announcement * announcement copy changes * content changes * copy update * Linting fixes and other tweaks. * Update 1.Bug_report.md * Update roadmap.tsx * Fixed typo * Progress commit for new release notes. * Update 2021-12-01.mdx * copy changes to release note * small content change * copy updates * fix import * fix copy Co-authored-by: Mitchell Hamilton <mitchell@hamil.town> * copy updates * specify TypeScript type changes * remove typescript help * remove repeated words * less want, more relation * Update docs/pages/releases/index.mdx Co-authored-by: Daniel Cousens <413395+dcousens@users.noreply.github.com> * copy changes Co-authored-by: Daniel Cousens <413395+dcousens@users.noreply.github.com> * Slight tweaks for GA content * Fixed page title issue on GA announcement * Fixed "we are here" marker on roadmap * Roadmap updates * Fix react warnings * revert title bad merge * Update 2021-12-01.mdx Co-authored-by: Jonathan Corral <johnlejardinnier@gmail.com> Co-authored-by: Dominik Wilkowski <hi@dominik-wilkowski.com> Co-authored-by: davidpmccormick <d.mccormick@wellcome.ac.uk> Co-authored-by: Charles <cc.lee@live.com.au> Co-authored-by: Ronald Aveling <luma.chroma@gmail.com> Co-authored-by: Ronald Aveling <ronald.aveling@thinkmill.com.au> Co-authored-by: Daniel Cousens <413395+dcousens@users.noreply.github.com> Co-authored-by: Mitchell Hamilton <mitchell@hamil.town> Co-authored-by: Jed Watson <872310+JedWatson@users.noreply.github.com>
- Loading branch information
1 parent
eacfe06
commit 6742d65
Showing
15 changed files
with
913 additions
and
300 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,105 @@ | ||
import { Markdown, getStaticProps } from '../../components/Markdown'; | ||
import { Emoji } from '../../components/primitives/Emoji'; | ||
import { Stack } from '../../components/primitives/Stack'; | ||
|
||
# Release: 1st December 2021 | ||
|
||
This release marks the achievement of **General Availability** status for Keystone 6! <Emoji symbol="🚀" alt="Rocket"/> | ||
|
||
We’ve also included a range of improvements to Keystone’s TypeScript DX since shipping [last week’s release candidate](/releases/2021-11-24). | ||
|
||
## Keystone 6 <Emoji symbol="⚡️" alt="Lightning" /> | ||
|
||
With this major release, the project has moved to the `@keystone-6` namespace on npm, and our version numbers have been reset. | ||
|
||
We **highly recommend you upgrade** your existing **Keystone Next** projects to **Keystone 6** with the packages below: | ||
|
||
```json | ||
"@keystone-6/auth": "1.0.0", | ||
"@keystone-6/cloudinary": "1.0.0", | ||
"@keystone-6/document-renderer": "1.0.0", | ||
"@keystone-6/fields-document": "1.0.0", | ||
"@keystone-6/core": "1.0.0", | ||
"@keystone-6/session-store-redis": "1.0.0", | ||
``` | ||
|
||
?> **Note:** `@keystone-next/keystone` has been changed to `@keystone-6/core` | ||
|
||
Among other internal naming changes, our CLI commands have switched from `keystone-next` to simply `keystone`, please ensure you update your startup scripts to suit! | ||
|
||
!> To learn more about this major release and what’s in store for the road ahead, checkout our official [general availability announcement](/updates/general-availability) and updated [roadmap](/updates/roadmap). | ||
|
||
## Type Enhancements <Emoji symbol="✨" alt="Sparkles" /> | ||
|
||
We've shipped a significant update to our generated TypeScript types. | ||
|
||
The types for your schema are stricter when your lists are contextually typed by the newly provided `Lists` types from `.keystone/types`. | ||
This results in a smoother, type-safe auto-complete experience and stricter types for your access control, hooks, and any other code that uses a Keystone context. | ||
|
||
For example, if you write all your lists in one object: | ||
|
||
```ts | ||
import { Lists } from '.keystone/types' | ||
|
||
export const lists: Lists = { | ||
Blah: list({...}) | ||
} | ||
``` | ||
|
||
If you're defining your lists separately, you can do this: | ||
|
||
```ts | ||
import { Lists } from '.keystone/types' | ||
|
||
export const Blah: Lists.Blah = list({ | ||
... | ||
}) | ||
``` | ||
|
||
For a more in-depth view of what TypeScript types have been changed, see below: | ||
|
||
- The following types have been renamed: | ||
- `BaseGeneratedListTypes` → `BaseListTypeInfo` | ||
- `ItemRootValue` → `BaseItem` | ||
- `ListInfo` → `ListGraphQLTypes` | ||
- `TypesForList` → `GraphQLTypesForList` | ||
- `FieldTypeFunc` now has a required type parameter which must satisfy `BaseListTypeInfo` | ||
- The following types now have a required type parameter which must satisfy `BaseKeystoneTypeInfo`: | ||
- `ServerConfig` | ||
- `CreateRequestContext` | ||
- `AdminUIConfig` | ||
- `DatabaseConfig` | ||
- `ListOperationAccessControl` | ||
- `MaybeSessionFunction` | ||
- `MaybeItemFunction` | ||
- `GraphQLResolver` and `GraphQLSchemaExtension` now have a required type parameter which must satisfy `KeystoneContext` | ||
- `KeystoneGraphQLAPI` no longer has a type parameter | ||
- The first parameter to the resolver in a `virtual` field will be typed as the item type if the list is typed with `Keystone.Lists` or `Keystone.Lists.ListKey`, otherwise it will be typed as `unknown` | ||
- The `item`/`originalItem` arguments in hooks/access control will now receive the `Item` type if the list is typed with `Keystone.Lists` or `Keystone.Lists.ListKey`, otherwise it will be typed as `BaseItem` | ||
- `args` has been removed from `BaseListTypeInfo` | ||
- `inputs.orderBy` and `all` has been added to `BaseListTypeInfo` | ||
- In `.keystone/types`: | ||
- `ListKeyListTypeInfo` has been moved to `Lists.ListKey.TypeInfo` | ||
- `KeystoneContext` has been renamed to `Context` | ||
|
||
## Credits <Emoji symbol="💫" alt="Circle Star" /> | ||
|
||
This release would not have been possible without the support and feedback of such an awesome developer community. | ||
|
||
We’re grateful for the ideas you bring, the help you give others, and the code contributions the you’ve made to get Keystone to where it is today. | ||
|
||
!> Like this release? [Give us a star](https://github.com/keystonejs/keystone) on GitHub! | ||
|
||
## Complete Changelog <Emoji symbol="📜" alt="Scroll" /> | ||
|
||
You can also view the [verbose release notes](https://github.com/keystonejs/keystone/pull/7018) for this release on GitHub. | ||
|
||
export default ({ children, ...props }) => ( | ||
<Markdown | ||
description="Keystone 6 has hit **General Availability**! We've shipped several more improvements since our release candidate last week." | ||
{...props} | ||
> | ||
{children} | ||
</Markdown> | ||
); | ||
export { getStaticProps }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.