Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Example boilerplates and Document Field Customisation Example #7813

Merged
merged 8 commits into from
Sep 2, 2022

Conversation

flexdinesh
Copy link
Contributor

@flexdinesh flexdinesh commented Aug 19, 2022

Example boilerplates to quickly copy-paste to create a new example

  • Boilerplate code for creating feature examples
  • Boilerplate code for creating E2E examples with Next.js

Document field customisation E2E example

  • (Keystone server) Seed data setup with post content to demonstrate inline formatting, block formatting and custom components so users can see how things work right from the get go
  • (Keystone server) Blog-like schema
  • (Keystone server) 6 example component blocks to demonstrate how to build custom components for the document field using the component API
    • Carousel (fields.array, fields.text, fields.url)
    • Hero Image (fields.conditional, fields.empty, fields.child)
    • Callout (chromeless, fields.select, fields.child, toolbar)
    • Quote (fields.child)
    • Tweet (fields.url)
    • YouTube Video (fields.url, fields.text)
  • (Next.js frontend) DocumentRenderer customisation demonstrating how to customise default inline and block elements
  • (Next.js frontend) DocumentRenderer customisation demonstrating how to render the custom component blocks configured in the document field
  • No changesets since these are only examples and we don't wanna version them

TODO BEFORE MERGE

  • Will need to update the script for generating artifacts to use a pattern and not hardcode examples/e2e-boilerplate/keystone-server and examples/document-field-customisation/keystone-server in the script.

@flexdinesh flexdinesh requested a review from a team August 19, 2022 01:56
@changeset-bot
Copy link

changeset-bot bot commented Aug 19, 2022

⚠️ No Changeset found

Latest commit: 8340d70

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel
Copy link

vercel bot commented Aug 19, 2022

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

Name Status Preview Updated
keystone-next-docs ✅ Ready (Inspect) Visit Preview Sep 2, 2022 at 7:19AM (UTC)

@codesandbox-ci
Copy link

codesandbox-ci bot commented Aug 19, 2022

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 8340d70:

Sandbox Source
@keystone-6/sandbox Configuration

@flexdinesh flexdinesh force-pushed the dinesh/document-field-examples branch from 0e689cd to c9c3032 Compare August 19, 2022 02:01
@vercel vercel bot temporarily deployed to Preview August 19, 2022 02:05 Inactive
@flexdinesh flexdinesh force-pushed the dinesh/document-field-examples branch from c9c3032 to 0d4d38b Compare August 19, 2022 03:38
@vercel vercel bot temporarily deployed to Preview August 19, 2022 03:40 Inactive
@flexdinesh flexdinesh force-pushed the dinesh/document-field-examples branch from 0d4d38b to 9098fc4 Compare August 19, 2022 04:27
@vercel vercel bot temporarily deployed to Preview August 19, 2022 04:29 Inactive
@flexdinesh flexdinesh force-pushed the dinesh/document-field-examples branch from 9098fc4 to 74834d6 Compare August 19, 2022 08:13
@vercel vercel bot temporarily deployed to Preview August 19, 2022 08:16 Inactive
@vercel vercel bot temporarily deployed to Preview August 26, 2022 12:55 Inactive
@flexdinesh flexdinesh force-pushed the dinesh/document-field-examples branch from ed7b1ae to eb23c35 Compare August 26, 2022 12:56
@vercel vercel bot temporarily deployed to Preview August 26, 2022 13:00 Inactive
@flexdinesh flexdinesh force-pushed the dinesh/document-field-examples branch from eb23c35 to 564df01 Compare August 26, 2022 13:03
@vercel vercel bot temporarily deployed to Preview August 26, 2022 13:06 Inactive
@flexdinesh flexdinesh force-pushed the dinesh/document-field-examples branch from 564df01 to 1eee4c7 Compare August 28, 2022 05:18
@vercel vercel bot temporarily deployed to Preview August 28, 2022 05:20 Inactive
@flexdinesh flexdinesh force-pushed the dinesh/document-field-examples branch from 1eee4c7 to d2112ea Compare August 28, 2022 05:30
@vercel vercel bot temporarily deployed to Preview August 28, 2022 05:32 Inactive
@flexdinesh flexdinesh force-pushed the dinesh/document-field-examples branch from d2112ea to 64004e6 Compare August 28, 2022 12:40
@vercel vercel bot temporarily deployed to Preview August 28, 2022 12:43 Inactive
@flexdinesh flexdinesh changed the title Feature and E2E boilerplate Example boilerplates and Document Field Customisation Example Aug 28, 2022
@flexdinesh flexdinesh force-pushed the dinesh/document-field-examples branch from 64004e6 to fcc063b Compare August 28, 2022 22:42
@flexdinesh flexdinesh marked this pull request as ready for review August 28, 2022 22:42
@vercel vercel bot temporarily deployed to Preview August 28, 2022 22:44 Inactive
@vercel vercel bot temporarily deployed to Preview August 29, 2022 00:01 Inactive
@vercel vercel bot temporarily deployed to Preview August 31, 2022 01:24 Inactive
Copy link
Member

@emmatown emmatown left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have some other Thoughts on some other things here that I would like to be different but nothing that needs to block this.

@vercel vercel bot temporarily deployed to Preview September 2, 2022 00:46 Inactive
@vercel vercel bot temporarily deployed to Preview September 2, 2022 05:43 Inactive
Copy link
Member

@emmatown emmatown left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(my Thoughts were addressed with the new commits for anyone randomly reading this)

@vercel vercel bot temporarily deployed to Preview September 2, 2022 06:10 Inactive
@vercel vercel bot temporarily deployed to Preview September 2, 2022 07:19 Inactive
@flexdinesh flexdinesh merged commit db03e8d into main Sep 2, 2022
@flexdinesh flexdinesh deleted the dinesh/document-field-examples branch September 2, 2022 07:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants