Rename demo-projects folder to examples (keystonejs#3534)

* Rename demo-projects folder to examples

* Update test-projects/README.md

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

* Fix some strange git ignoreness

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

.changeset/sixty-garlics-hear.md

@@ -0,0 +1,8 @@
+---
+'@keystonejs/demo-project-blog': patch
+'@keystonejs/demo-custom-fields': patch
+'@keystonejs/demo-project-meetup': patch
+'@keystonejs/demo-project-todo': patch
+---
+
+Renamed `demo-projects` folder to `examples` to allow for future smaller focused examples.

.gitignore

@@ -1,5 +1,5 @@
 packages/test-project/public
-demo-projects/test-project
+examples/test-project
 
 # Logs
 logs

.prettierignore

@@ -5,8 +5,8 @@ coverage
 packages/test-project/public
 website/.cache/**/*
 website/public/**/*
-demo-projects/todo/.cache
-demo-projects/blog/app/.next
+examples/todo/.cache
+examples/blog/app/.next
 packages/arch/www/public/**/*
 .changeset/**/*
 **/dist

README.md

@@ -159,7 +159,7 @@ We'd like to start by thanking all our wonderful contributors:
 These projects are designed to show off different aspects of KeystoneJS features
 at a range of complexities (from a simple Todo App to a complex Meetup Site).
 
-See the [`demo-projects/README.md`](/demo-projects/README.md) docs to get
+See the [`examples/README.md`](/examples/README.md) docs to get
 started.
 
 ### Development Practices
@@ -190,7 +190,7 @@ yarn
 yarn dev
 ```
 
-See [`demo-projects/README.md`](/demo-projects/README.md) for more details on
+See [`examples/README.md`](/examples/README.md) for more details on
 the available demo projects.
 
 #### Note For Windows Users

docs/guides/custom-field-types.md

@@ -20,7 +20,7 @@ Type/views/
 
 ## Example
 
-For an example of a custom field, please see the [Stars field](https://github.com/keystonejs/keystone/tree/master/demo-projects/custom-fields/) in the basic test project.
+For an example of a custom field, please see the [Stars field](https://github.com/keystonejs/keystone/tree/master/examples/custom-fields/) in the basic test project.
 
 ## Implementation
 

docs/tutorials/custom-fields.md

@@ -103,7 +103,7 @@ The rest of the views relate to React components rendered in the Admin UI. We ca
   <Stars count={5} value={3}>
 ```
 
-You can find an example of this component in the [custom-fields demo project](https://github.com/keystonejs/keystone/tree/master/demo-projects/custom-fields/fields/Stars/views/Stars.js).
+You can find an example of this component in the [custom-fields demo project](https://github.com/keystonejs/keystone/tree/master/examples/custom-fields/fields/Stars/views/Stars.js).
 
 Once we have a component for star ratings we can use this in Keystone.
 
@@ -149,4 +149,4 @@ That's it, we now have a basic custom field.
 
 ## Next Steps
 
-Take a look at this example and others in the [custom-fields demo project](https://github.com/keystonejs/keystone/tree/master/demo-projects/custom-fields/) in the Keystone repository.
+Take a look at this example and others in the [custom-fields demo project](https://github.com/keystonejs/keystone/tree/master/examples/custom-fields/) in the Keystone repository.

demo-projects/blog/package.json → examples/blog/package.json

@@ -45,5 +45,5 @@
     "react": "^16.13.1",
     "react-dom": "^16.13.1"
   },
-  "repository": "https://github.com/keystonejs/keystone/tree/master/demo-projects/blog"
+  "repository": "https://github.com/keystonejs/keystone/tree/master/examples/blog"
 }

demo-projects/custom-fields/package.json → examples/custom-fields/package.json

@@ -29,5 +29,5 @@
     "cross-env": "^7.0.2",
     "react": "^16.13.1"
   },
-  "repository": "https://github.com/keystonejs/keystone/tree/master/demo-projects/custom-fields"
+  "repository": "https://github.com/keystonejs/keystone/tree/master/examples/custom-fields"
 }

demo-projects/meetup/meetupConfig.js → examples/meetup/meetupConfig.js

@@ -38,7 +38,7 @@ const MEETUP = {
     copyrightText: `
 <p>Copyright &copy; Thinkmill Pty Ltd, powered by <a href="https://keystonejs.com">KeystoneJS</a>.</p>
 <p>If you run a meetup, please feel free to clone our site and make your own!
-  <a href="/keystonejs/keystone/tree/master/demo-projects/meetup">You can find it on GitHub</a>.
+  <a href="/keystonejs/keystone/tree/master/examples/meetup">You can find it on GitHub</a>.
 </p>
 `,
   },

demo-projects/meetup/package.json → examples/meetup/package.json

@@ -48,5 +48,5 @@
     "react-use-form-state": "^0.13.1",
     "uuid": "^8.3.0"
   },
-  "repository": "https://github.com/keystonejs/keystone/tree/master/demo-projects/meetup"
+  "repository": "https://github.com/keystonejs/keystone/tree/master/examples/meetup"
 }

demo-projects/todo/.gitignore → examples/todo/.gitignore

@@ -107,7 +107,6 @@ tags
 # End of https://www.gitignore.io/api/vim
 
 temp/
-/public
-/dist
+dist/
 .cache
 .next

demo-projects/todo/package.json → examples/todo/package.json

@@ -22,5 +22,5 @@
     "@keystonejs/keystone": "^14.0.1",
     "cross-env": "^7.0.2"
   },
-  "repository": "https://github.com/keystonejs/keystone/tree/master/demo-projects/todo"
+  "repository": "https://github.com/keystonejs/keystone/tree/master/examples/todo"
 }

package.json

@@ -9,7 +9,7 @@
   "homepage": "https://github.com/keystonejs/keystone",
   "scripts": {
     "dev": "yarn demo todo dev",
-    "demo": "yarn --cwd ./demo-projects",
+    "demo": "yarn --cwd ./examples",
     "website": "manypkg run website",
     "arch-docs": "manypkg run arch/docs",
     "coverage": "cross-env DISABLE_LOGGING=true NODE_ENV=test jest --maxWorkers=1 --coverage",
@@ -136,7 +136,7 @@
       "!packages/arch",
       "packages/arch/docs",
       "packages/arch/packages/*",
-      "demo-projects/*",
+      "examples/*",
       "test-projects/*",
       "api-tests",
       "benchmarks",

test-projects/README.md

@@ -1,6 +1,6 @@
 ## ATTENTION
 
-This folder contains projects used for Cypress tests. You do not want to use these as starting points for your own project. You are better off using the demo projects for that, which are located in `/demo-projects`.
+This folder contains projects used for Cypress tests. You do not want to use these as starting points for your own project. You are better off using the example projects for that, which are located in `/examples`.
 
 ## Cypress Projects