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

Admin UI customisation guides and examples #6082

Merged
merged 45 commits into from
Jul 28, 2021

Conversation

gwyneplaine
Copy link
Contributor

The following PR contains the guides and examples for the following:

  • Custom pages in the admin-ui
  • Custom components in the admin-ui

@changeset-bot
Copy link

changeset-bot bot commented Jul 11, 2021

🦋 Changeset detected

Latest commit: 883f2e1

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@keystone-next/example-custom-admin-ui-pages Major

Not sure what this means? Click here to learn what changesets are.

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

@vercel
Copy link

vercel bot commented Jul 11, 2021

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/keystonejs/keystone-next-docs/5YTSCS6yvwnWh7wbhmKonB2qaDXh
✅ Preview: https://keystone-next-docs-git-example-admin-ui-custo-1d7282-keystonejs.vercel.app

@gwyneplaine gwyneplaine force-pushed the example/admin-ui-customisation branch from d3e5575 to 8bc9a3b Compare July 12, 2021 00:05
@vercel vercel bot temporarily deployed to Preview July 12, 2021 00:05 Inactive
@vercel vercel bot temporarily deployed to Preview July 12, 2021 00:25 Inactive
@vercel vercel bot temporarily deployed to Preview July 12, 2021 00:28 Inactive
@codesandbox-ci
Copy link

codesandbox-ci bot commented Jul 12, 2021

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.

@vercel vercel bot temporarily deployed to Preview July 12, 2021 00:35 Inactive
@gwyneplaine
Copy link
Contributor Author

@timleslie @JedWatson Removing reference to @keystone-ui/core and primitives there because that entire set of packages are undocumented, at a minimum we should host the design-system website on a public domain before recommending usage of those packages.

(happy to do this after this PR lands)

As an aside we should re-evaluate how we help users create custom-pages, even exposing a simple Layout component so users can get this:
Screen Shot 2021-07-12 at 11 16 38 am

At the moment, getting to this point ^ is not possible without digging through source code and a significant amount of manual effort.

@vercel vercel bot temporarily deployed to Preview July 12, 2021 03:28 Inactive
@vercel vercel bot temporarily deployed to Preview July 12, 2021 03:31 Inactive
@gwyneplaine gwyneplaine force-pushed the example/admin-ui-customisation branch from 925b1dd to 9f6a87f Compare July 12, 2021 03:31
@vercel vercel bot temporarily deployed to Preview July 12, 2021 03:34 Inactive
@vercel vercel bot temporarily deployed to Preview July 12, 2021 03:46 Inactive
@gwyneplaine gwyneplaine force-pushed the example/admin-ui-customisation branch from 02e8b22 to 673210c Compare July 12, 2021 03:46
@vercel vercel bot temporarily deployed to Preview July 12, 2021 03:48 Inactive
@gwyneplaine gwyneplaine force-pushed the example/admin-ui-customisation branch from 673210c to 47b5590 Compare July 12, 2021 03:55
@vercel vercel bot temporarily deployed to Preview July 12, 2021 03:55 Inactive
@vercel vercel bot temporarily deployed to Preview July 12, 2021 03:59 Inactive
@vercel vercel bot temporarily deployed to Preview July 12, 2021 04:01 Inactive
@vercel vercel bot temporarily deployed to Preview July 12, 2021 04:16 Inactive
@gwyneplaine gwyneplaine force-pushed the example/admin-ui-customisation branch from b307aa0 to ec6d904 Compare July 12, 2021 04:32
@vercel vercel bot temporarily deployed to Preview July 12, 2021 04:32 Inactive
@gwyneplaine gwyneplaine force-pushed the example/admin-ui-customisation branch from ec6d904 to 209181e Compare July 12, 2021 04:32
@vercel vercel bot temporarily deployed to Preview July 12, 2021 04:34 Inactive
@vercel vercel bot temporarily deployed to Preview July 12, 2021 04:45 Inactive
@vercel vercel bot temporarily deployed to Preview July 12, 2021 04:59 Inactive
gwyneplaine and others added 7 commits July 28, 2021 10:42
Co-authored-by: Tim Leslie <timl@thinkmill.com.au>
Co-authored-by: Tim Leslie <timl@thinkmill.com.au>
Co-authored-by: Tim Leslie <timl@thinkmill.com.au>
Co-authored-by: Tim Leslie <timl@thinkmill.com.au>
Co-authored-by: Tim Leslie <timl@thinkmill.com.au>
Co-authored-by: Tim Leslie <timl@thinkmill.com.au>
@gwyneplaine gwyneplaine force-pushed the example/admin-ui-customisation branch from 126b8a8 to 498e0f2 Compare July 28, 2021 00:45
@vercel vercel bot temporarily deployed to Preview July 28, 2021 00:45 Inactive
@vercel vercel bot temporarily deployed to Preview July 28, 2021 00:49 Inactive
examples/README.md Outdated Show resolved Hide resolved
@vercel vercel bot temporarily deployed to Preview July 28, 2021 01:09 Inactive
gwyneplaine and others added 4 commits July 28, 2021 11:14
Copy link
Contributor

@timleslie timleslie left a comment

Choose a reason for hiding this comment

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

👍

@gwyneplaine gwyneplaine enabled auto-merge (squash) July 28, 2021 01:58
@vercel vercel bot temporarily deployed to Preview July 28, 2021 02:02 Inactive
@vercel vercel bot temporarily deployed to Preview July 28, 2021 02:08 Inactive
@gwyneplaine gwyneplaine merged commit e0b9e8d into master Jul 28, 2021
@gwyneplaine gwyneplaine deleted the example/admin-ui-customisation branch July 28, 2021 02:12
Nikitoring pushed a commit to Nikitoring/keystone that referenced this pull request Sep 14, 2021
* init

* guides for custom page and custom components

* more examples commits

* yarn.lock  and example changes

* add more markup

* Update docs/pages/docs/guides/custom-admin-ui-pages.mdx

Co-authored-by: Mitchell Hamilton <mitchell@hamil.town>

* fix readme

* more updates to the docs

* add smoke tests

* add to smoke tests in workflow

* fill in links

* add new guides to docs nav

* fix docs

* fix readME.md

* changelog reset

* add examples link to docs and README.md

* update explanation of Old JSX transforms

* change custom-admin-ui-components example to custom-admin-ui-logo

* Update docs/pages/docs/guides/custom-admin-ui-pages.mdx

Co-authored-by: Tim Leslie <timl@thinkmill.com.au>

* Update docs/pages/docs/guides/custom-admin-ui-pages.mdx

Co-authored-by: Tim Leslie <timl@thinkmill.com.au>

* Update docs/pages/docs/guides/custom-admin-ui-pages.mdx

Co-authored-by: Tim Leslie <timl@thinkmill.com.au>

* Update docs/pages/docs/guides/custom-admin-ui-pages.mdx

Co-authored-by: Tim Leslie <timl@thinkmill.com.au>

* Update examples/custom-admin-ui-pages/README.md

Co-authored-by: Tim Leslie <timl@thinkmill.com.au>

* Update examples/custom-admin-ui-pages/README.md

Co-authored-by: Tim Leslie <timl@thinkmill.com.au>

* Update examples/custom-admin-ui-components/README.md

Co-authored-by: Tim Leslie <timl@thinkmill.com.au>

* Update examples/custom-admin-ui-pages/admin/pages/custom-page.tsx

Co-authored-by: Tim Leslie <timl@thinkmill.com.au>

* Update examples/custom-admin-ui-components/README.md

Co-authored-by: Tim Leslie <timl@thinkmill.com.au>

* fix up odds and ends in formatting for docs pages

* Update docs/pages/docs/guides/custom-admin-ui-logo.mdx

Co-authored-by: Tim Leslie <timl@thinkmill.com.au>

* Update docs/pages/docs/guides/custom-admin-ui-logo.mdx

Co-authored-by: Tim Leslie <timl@thinkmill.com.au>

* Update docs/pages/docs/guides/custom-admin-ui-pages.mdx

Co-authored-by: Tim Leslie <timl@thinkmill.com.au>

* Update docs/pages/docs/guides/custom-admin-ui-pages.mdx

Co-authored-by: Tim Leslie <timl@thinkmill.com.au>

* Update docs/pages/docs/guides/custom-admin-ui-pages.mdx

Co-authored-by: Tim Leslie <timl@thinkmill.com.au>

* Update docs/pages/docs/guides/custom-admin-ui-logo.mdx

Co-authored-by: Tim Leslie <timl@thinkmill.com.au>

* Feedback from Tim

* remove unnecessary files

* yarn.lock

* add changeset

* Update examples/README.md

Co-authored-by: Tim Leslie <timl@thinkmill.com.au>

* update schema.graphql

* http --> https

Co-authored-by: Mitchell Hamilton <mitchell@hamil.town>
Co-authored-by: Tim Leslie <timl@thinkmill.com.au>
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.

5 participants