Reviewed Getting Started documentation #4721
Merged
Conversation
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
FIxed spelling, grammar and broken link issues with the Getting Started documentation.
stennie
reviewed
Jul 23, 2018
| @@ -29,7 +29,7 @@ At this point, we should have a `node_modules` directory and keystone should hav | |||
|
|
|||
| Create a new file, `keystone.js` and we're ready to start configuring keystone. | |||
|
|
|||
| Your `keystone.js` file is the launch file for keystone, which will connect keystone to your database, start both the database connection, and start your server running. This is where we will be adding configuration options to keystone as well, which allow us to change how keystone is running. | |||
| Your `keystone.js` file is the launch file for keystone, which will connect keystone to your database, start the database connection, and start your server running. This is where we will be adding configuration options to keystone as well, which allow us to change how keystone is running. | |||
There was a problem hiding this comment.
Can we be consistent with Keystone uppercase?
| We should get a 404 page. That's ok! We're going to solve that in [part 3](/getting-started/setting-up/part-3). In [Part 2](/getting-started/setting-up/part-2) we are going to focus on getting the database connected, and the admin UI up and running. You can do these two in either order. | ||
|
|
||
| ## Next Steps | ||
| Check out [part 2](/getting-started/setting-up/part-2) of our setting up keystone guide, which walks you through setting up your database, or if you want to read more about any of the parts we set up, you can check out these links: |
There was a problem hiding this comment.
Part 2: Database Setup
... "of this guide"
| @@ -120,8 +120,7 @@ email: { type: keystone.Field.Types.Email, unique: true }, | |||
|
|
|||
| Email is similar to password in that it is using a keystone-specific field type, in this case to ensure that when this field is filled, it has the shape of an email. In addition, we have passed a second option of `unique: true`, which forces the field to be unique within the database. No doubling up on email addresses for accounts. | |||
|
|
|||
| // The following para really needs more work. Needs lightness and timing | |||
| If you want to know about all the field types keystone offers, you can find the information find the full list of options in the [field docs](/api/field) Also, for the options like `unique` which are available to all fields, you can read more [here](/api/field/options), for when you are making your own models. | |||
| If you want to know about all the field types keystone offers, you can find the full list of options in the [field docs](/api/field) Also, for the options like `unique` which are available to all fields, you can read more [here](/api/field/options), for when you are making your own models. | |||
There was a problem hiding this comment.
"field docs" => "Field API documentation"
"here" => "Field options API"
| @@ -234,11 +233,11 @@ Event.register(); | |||
| ## Next Steps | |||
| Check out [part 3](/getting-started/setting-up/part-3) of our setting up keystone guide, which walks you through adding your own pages to your site, or if you want to read more about any of the parts we set up, you can check out these links: | |||
|
|
|||
| learn more about: | |||
| ## Learn more about: | |||
There was a problem hiding this comment.
Use page titles + proper case
| @@ -1,12 +1,12 @@ | |||
| # Part 3: Routing | |||
|
|
|||
| Keystone is designed to do much of the setup of running an [express](expressjs.com) application out of your hands as well as allowing an easy configuration of the options. | |||
| Keystone is designed to do much of the setup of running an [express](https://expressjs.com) application out of your hands as well as allowing an easy configuration of the options. | |||
| @@ -378,11 +378,11 @@ mixin flash-message(message, type) | |||
|
|
|||
| ### Using other template languages | |||
|
|
|||
| KeystoneJS supports any [template language supported by express](expressjs.com/en/api.html). | |||
| KeystoneJS supports any [template language supported by express](https://expressjs.com/en/api.html). | |||
docs/Getting Started/yo-generator.md
Outdated
|
|
||
| Use the `view engine` option to specify the template language you want to use. | ||
|
|
||
| If you want to use a custom template engine, set the `custom engine` option as well. For instance, [ejs](embeddedjs.com/) is supported by express by default, but you might want to use [ejs.locals](github.com/RandomEtc/ejs-locals) as a template engine in order to benefit from get extensions. | ||
| If you want to use a custom template engine, set the `custom engine` option as well. For instance, [ejs](http://embeddedjs.com/) is supported by express by default, but you might want to use [ejs.locals](https://github.com/RandomEtc/ejs-locals) as a template engine in order to benefit from get extensions. |
There was a problem hiding this comment.
Should this be EJS and http://ejs.co?
docs/Getting Started/yo-generator.md
Outdated
| @@ -402,7 +402,7 @@ You'll want to add your own css, javascript, images and other files to your proj | |||
|
|
|||
| Keystone will serve any static assets you place in the public directory. This path is specified in `keystone.js` by the `static` option. | |||
|
|
|||
| It will also automatically generate `.css` or compressed `.min.css` files when a corresponding `.less` file is found in the public folder, as specified in `keystone.js` by the `less` option. For more information on LESS, see [lesscss.org](lesscss.org). | |||
| It will also automatically generate `.css` or compressed `.min.css` files when a corresponding `.less` file is found in the public folder, as specified in `keystone.js` by the `less` option. For more information on LESS, see [lesscss.org](http://lesscss.org). | |||
There was a problem hiding this comment.
"It" => ? (presumably Keystone)
docs/Getting Started/yo-generator.md
Outdated
| @@ -414,7 +414,7 @@ When the option is set to `true`, Keystone will scan the `updates` directory for | |||
|
|
|||
| - next - the method to call when the update has finished running (including any internal callbacks) | |||
|
|
|||
| Updates are ordered using [Semantic Versioning](semver.org), and Keystone will only run them once (successfully executed updates are stored in your database, in a collection called `app_updates`). | |||
| Updates are ordered using [Semantic Versioning](https://semver.org), and Keystone will only run them once (successfully executed updates are stored in your database, in a collection called `app_updates`). | |||
There was a problem hiding this comment.
Could split into two sentences for clarity. I also think Keystone will only apply once, if successful.
docs/Getting Started/yo-generator.md
Outdated
| @@ -449,14 +449,14 @@ Now you're ready to run your application, so execute the following in your proje | |||
|
|
|||
| Keystone will automatically apply the update, and then start a web server on the default port, 3000. | |||
|
|
|||
| To see your home page, point your browser at [localhost:3000](localhost:3000). You should see our **Hello World!** message. | |||
| To see your home page, point your browser at [localhost:3000](http://localhost:3000). You should see our **Hello World!** message. | |||
- Ensured that Keystone is capitalised everywhere in the docs - Set Mongoose docs link to V4
stennie
approved these changes
Jul 23, 2018
|
Thanks @nathansimpson95! Great first contribution :) Cheers, |
ghbolivar
added a commit
to ghbolivar/keystone
that referenced
this pull request
Feb 24, 2019
* Playing with Travic CI build * Playing with Travic CI build * Fix attempt for issue keystonejs#3979 packages.js generates a Uncaught SyntaxError: Unexpected string when minified, and fails to load the admin interface. After some digging I found that uglifyjs compresses the typeof checks into the following format "undefined"==typeof x which triggers a syntax error after passing through another minification process when deployed. A way to prevent this from happening is to allow semicolons in the uglifyjs command. Also needed to add the 'aphrodite/no-important' to the required packages for the Admin UI. * Updating contact info * Correcting password type check in PasswordType * fix:typo in handleError in screens/Item/index.js * fix:module-name in import statement in EditForm.js It was working before but the `./` was extraneous and redundant. * Fix: model with required field that defaults to 0 can't be saved Number.prototype.validateRequiredInput() merely checked if the getter for the field returned a truthy value. That fails if the default happens to be zero (which is a falsy value). The fix is to simply check if the return value is a number. * Fix: model with required field that defaults to false can't be saved Boolean variant of commit d28bacc. * Commenting out redundant code in www dir * Removing `path` from server/initViewEngine * Removing commented out PropTypes import * Removing redundant import * [WIP] Updating packages (only minors and patches) * [WIP] Updating more packages (minor & patch) * Updating last of the minor and patch packages * Removing old aphropdite references * Fixing some "Prop types declarations should be sorted alphabetically" (react/sort-prop-types) errors, allowing `npm run lint` to run * Changes to the few dependencies that were depending on mime@2.x: - knox has been replaced with keystonejs/knox as the package is not being maintained anymore and has a `*` for `mime` - superagent@3.6.0 uses mime@1.3.6 (which is compatible with node <=6.x) * Fixing CSRF by reverting the (well meaning) changes made in PR 3756 (keystonejs/keystone#3756). I don't know if this will resurface issue 3420 (keystonejs/keystone#3420), which the PR apparently addressed. * Add some functionality to prevent macro injection via CSV export * Fixing file extention * extract password validation so users can access the validation within their own code for things like password reset * Correcting password type check in PasswordType * Expanding password field configuration options and improving defaults (to align with current NIST guidelines). Updating, expanding on and clarifying relevant docs. * Escaping values in the raw value of markdown field so it can be safely displayed within an HTML document * Sanitization update to markdown fields -- remove unsafe html tags from the markdown value before it's rendered into html * Updating the markdown fieldtype docs to include the new sanitizer options * Prep'ing for release as 4.0.0-beta.6 * Fixed in Adapters.FS * nerfed strongly worded comment * Updating packages * v4.0.0-beta.7 * Documentation about customizing the navigation bar * Add packages.js build * Fix Password `validateInput` breaking tests related to security updates * Revert "Merge branch 'jm-fork' into master" This reverts commit 8008781, reversing changes made to f08baa4. * (feat) implements image thumbnails for the File type * moved thumb check to field level * Fix for known security vulnerability in marked 0.3.6 dependency * updating packages * v4.0.0-beta.8 * Fix autocleanup for cloudinary fixes 3476 (keystonejs#4205) * Update `cloudinaryimage` to respect autocleanup * Fixes autocleanup for cloudinaryimages * Remove completed TODOs * Deprecate currency setting (keystonejs#4132) * fix paginate to return on count error (keystonejs#4167) * Update README.md (keystonejs#4569) Add field type Code (http://keystonejs.com/docs/database/#fieldtypes-code) * Should check undefined instead, otherwise value === 0 will not be able to show (keystonejs#4524) * Update application-updates.md (keystonejs#4582) * Update yo-generator.md (keystonejs#4581) * Update Readme.md (keystonejs#4583) * replace hardcode keystone to path admin variable (keystonejs#4586) * replace knox git dependency with knox-s3 (keystonejs#4574) - knox-s3 is a fork of knox with one difference: a mime 1.x dependency that avoids breaking changes in mime 2.x - this matches the `keystonejs/knox` repo, but is published to npm - allows keystone to be installed without git e.g. in a node:slim Docker container close keystonejs#4573 * Upgrade moment for CVE-2017-18214 (keystonejs#4592) For more info, see: https://nvd.nist.gov/vuln/detail/CVE-2017-18214 This is currently triggering github security alerts on all projects using keystone 4.x * Fix website (keystonejs#4615) * Update website to work * fixing one test at a time Signed-off-by: Dominik Wilkowski <Hi@Dominik-Wilkowski.com> * fixed keystonejs#4628 Signed-off-by: Dominik Wilkowski <Hi@Dominik-Wilkowski.com> * fixing some typos and unnessesary comments Signed-off-by: Dominik Wilkowski <Hi@Dominik-Wilkowski.com> * removed commented out tests as there are not meaningful Signed-off-by: Dominik Wilkowski <Hi@Dominik-Wilkowski.com> * fixing admin ui tests (thanks to Vito) Signed-off-by: Dominik Wilkowski <Hi@Dominik-Wilkowski.com> * Fix test failure due to password complexity requirement added in 8ecb809 * Fix the wrong link to typography * Added the typopgrahy plugin into gatsby-config * Update typography to latest version * Fix typo in @keystonejs and change GitHub link to https * Remove failing tests as discussed with @JedWatson and @dominikwilkowski * Keystone 4 website clean up and fixing stuff * Home page clean up, inclulding Header redesign * Doc page clean up, refactor the navigation * Mobile optimisations * A lot of minor polishes * Replace window.location.pathname with this.props.location.pathname * Add React Helmet * Add Twitter Butotn * Mobile optimsations * Linting warning fix * Adding in the missing DayPicker-WeekdaysRow (keystonejs#4601) * Adding in the missing DayPicker-WeekdaysRow * Fix keystonejs#4652: Remove EOL Node releases from Travis testing * show color swatch on color field Fixes issue: keystonejs/keystone#4074 * Fix keystonejs#4665: Update Readme for Keystone 4.0.0-rc0 * Fix missing bullets and tweak per feedback from Jed * Fix bullets & update RC title * Fix Relationship Fields link * Fix for empty relationships submitting no value * Fix for updating single relationship values * updating packages bundle Signed-off-by: Dominik Wilkowski <Hi@Dominik-Wilkowski.com> * Remove link to `keystone-starter` (currently a v0.3 demo that doesn't cleanly deploy to Heroku) * Add mention of new File API and link to Contributor Guide * Reorganise README sections and add Table of Contents * Move field type overview to documentation * Move dev & testing information to Contributor Guide * Change Netlify doc links to https * Change Thinkmill link to https * Consolidate the Contributing blurb * Update GitHub issue/PR templates * Tidy home page text & link to current release information * Fix keystonejs#4686: CloudinaryImage(s) fields were incorrectly marked as deprecated (keystonejs#4690) * Update deps according to semver * Remove --growl from Mocha options; fails on Mocha 4+ unless `growl-notify` is installed (ref: mochajs/mocha#3088) * Update to latest browserify * Upgrade `debug` dependency * Fix bug in Safari where XHR form submission fails with empty file input (keystonejs#4673) * Provides a fix for a bug in Safari where XHR form submission fails when input[type=file] is empty * Include keystone.version in startup message (keystonejs#4692) * Remove unused title markdown from README.md * updated packages bundle Signed-off-by: Dominik Wilkowski <Hi@Dominik-Wilkowski.com> * bumped version to RC1 Signed-off-by: Dominik Wilkowski <Hi@Dominik-Wilkowski.com> * Added session max age cookie to match keystone.uid cookie expiry * smooth scroll spped now based on current scroll position * Restore/repair S3 image uploading in tinymce * Use custom root for S3 paths * Check that req.session.cookie exists before setting maxAge * Make listing browser versions a more obvious PR testing requirement * Enhance numeric fields * Replace / with . to delimiter the file extension * Update part-4.md Corrected the api.event route. The "routes" was missing app.post('/api/event', routes.api.event.post); * Fix typo: s/gloing/going/ * Update options.md (keystonejs#4621) Fix typo error udpatedBy -> updatedBy * Fixed typo (keystonejs#4597) * Added letsencrypt configuration docs for keystonejs#4181 * Added more info on Application updates with required relationships. * Documented breaking change to `pre:routes` behaviour. * Update `package.json` reference to rc1 * Upgrade qs to 6.5.2 * Add pointer to Keystone 4 beta/RC release notes * - Upgrade to Mongoose 4.13.14: https://github.com/Automattic/mongoose/blob/master/History.md#41314--2018-05-25 - Add useMongoClient per http://thecodebarbarian.com/mongoose-4.11-use-mongo-client.html * Update z-index of color chooser The previous z-index of 2 was not enough for the popover to appear above the "Save" footer, which has z-index: 99 * Fix keystonejs#4706: Docs: Application Updates is 404 * Fix keystonejs#4707: Docs: Edit this page links are broken * Fix keystonejs#4688: Deprecated File field types have broken docs link * Remove WIP notes * Fix keystonejs#4708: Update Getting Started page * added semver notations to dependencies Signed-off-by: Dominik Wilkowski <Hi@Dominik-Wilkowski.com> * fixed typo Signed-off-by: Dominik Wilkowski <Hi@Dominik-Wilkowski.com> * Improve sanity checking for signin "from" param * Minor fixes and improvements to the location field type (keystonejs#4455) * Minor fix to location fields - no reason to depend on the order of address_components coming from Google * Minor fix to location fields - Better handling of `address_components` returned from Google API * Minor fix to location fields - no reason to depend on the order of address_components coming from Google * Minor fix to location fields - Better handling of `address_components` returned from Google API * Update to multer 1.3.1 and automatically clean uploaded files (keystonejs#4704) * Update to multer 1.3.1 and automatically clean uploaded files * Fix typo in bindBodyParser * Add missing next() (thanks @ttsirkia!) * Reviewed Getting Started documentation (keystonejs#4721) - FIxed spelling, grammar and broken link issues with the Getting Started documentation. - Ensured that Keystone is capitalised everywhere in the docs - Set Mongoose docs link to V4 * updating package bundle Signed-off-by: Dominik Wilkowski <Hi@Dominik-Wilkowski.com> * bumped version 📣🎉 Signed-off-by: Dominik Wilkowski <Hi@Dominik-Wilkowski.com> * FIxing broken links in README.md FIxing broken links in README.md * remove lock files Signed-off-by: Dominik Wilkowski <Hi@Dominik-Wilkowski.com> * ignore lock files Signed-off-by: Dominik Wilkowski <Hi@Dominik-Wilkowski.com> * Adding Favicon to Keystone 4 website Tested with Chrome and Firefox. * Added Google Analytics Code to V4 website * Removed incorrect image Removed safari-pinned-tab.svg, which was a black square. * Created 404.js Currently giving errors TypeError: Cannot read property 'initial' of undefined - index.js:22 ExtractTextPlugin.<anonymous> [website]/[extract-text-webpack-plugin]/index.js:22:9 - Array.forEach - index.js:21 ExtractTextPlugin.mergeNonInitialChunks [website]/[extract-text-webpack-plugin]/index.js:21:16 - index.js:275 ExtractTextPlugin.<anonymous> [website]/[extract-text-webpack-plugin]/index.js:275:12 - Array.forEach - index.js:273 ExtractTextPlugin.<anonymous> [website]/[extract-text-webpack-plugin]/index.js:273:21 - async.js:52 [website]/[async]/lib/async.js:52:16 - async.js:236 Object.async.forEachOf.async.eachOf [website]/[async]/lib/async.js:236:30 - async.js:209 Object.async.forEach.async.each [website]/[async]/lib/async.js:209:22 - index.js:237 ExtractTextPlugin.<anonymous> [website]/[extract-text-webpack-plugin]/index.js:237:10 - Tapable.js:71 Compilation.applyPluginsAsync [website]/[tapable]/lib/Tapable.js:71:13 - Compilation.js:525 Compilation.seal [website]/[webpack]/lib/Compilation.js:525:7 - Compiler.js:397 Compiler.<anonymous> [website]/[webpack]/lib/Compiler.js:397:15 - Tapable.js:103 [website]/[tapable]/lib/Tapable.js:103:11 - Compilation.js:445 Compilation.<anonymous> [website]/[webpack]/lib/Compilation.js:445:10 - Compilation.js:417 [website]/[webpack]/lib/Compilation.js:417:12 * Fixed broken links to componants And added a link to the logo in the header * Tweaking the content * Adding Google Analytics and Favicons (keystonejs#4740) * Adding Favicon to Keystone 4 website * Added Google Analytics Code to V4 website * Removed safari-pinned-tab.svg, which was a black square. * Add Netlify redirects for v3 paths to v4 equivalents * Fixed a typo in Project-Options.md The `name` option appears twice, instead of the 2nd being `brand`. * Fixed links to configuration pages * Link to 4.x release history * Make titles for Setting Up sections consistent * Include defaultColumns in code example * Improve section labels for Get Started * Clean up text & formatting * Clean up text & formatting * Update index.md minor wording error fix * Update part-4.md * Fix keystonejs#4762: Bump kerberos & letsencrypt-express dependencies * Correct typo in templates/views/addEvent.pug Fix keystonejs#4805 * Fix typo in part 4 of tutorial (thanks @ebrahimamer) * add alt test to delete button * Fix keystonejs#4815: Typo in Getting started part 4 tutorial * Fix keystonejs#4818: Add redirect for /guide/config * documentation updates * DOCS: Fix typo for TextArray Field * Update Underscore-Methods.md underscore instead of undercore * Update options.md Link is broken without `http://` * Fixed incorrectly named API method label (fixes keystonejs#4825) * docs(syntax): update an upper-case (keystonejs#4810) By copying and pasting the site, I realized that the list was previously referenced with an uppercase. * incorrect link to database docs (keystonejs#4833) * fix: fields explorer invalid capitilisations (keystonejs#4834) * Bug - Fix UTC DateColumn vaue display (keystonejs#4841) Added toMoment method to allow Moment.js to use utc dates. Updated getValue to use toMoment for proper output. * Fixed typo in paginate() docs (keystonejs#4839) * Refer to the newest release "4.0.0" Probably forgot to update part of readme from the older release "4.0.0.rc.1" * Completed opening sentence The sentence "Once you retrieve a list from Keystone, the mongoose methods can be accessed from." seemed incomplete * Added option to hide Today button in Date field (keystonejs#4869) * Fixed dependsOn setting when applied to a boolean field set to false by default (keystonejs#4867) * UPDATE deleteItem action with custom error message (keystonejs#4683) * Return a 500 error when `item.remove` fails (keystonejs#4832) * Return a 500 error when `item.remove` fails Currently, errors from `item.remove` are not handled at all in the callback. This gives an empty 200 back to the frontend, which will do nothing with this response (no visual feedback on the error). We should return an actual error. All suggestions on how to return this error Keystone style are welcome. * directly send the `err` to `apiError` * Build S3 upload name when not present (keystonejs#4871) * Restore/repair S3 image uploading in tinymce * Use custom root for S3 paths * Build S3 upload name when not present * Fix markup typo in quick start docs. (keystonejs#4854) The `auto update` field was highlighted incorrectly. * Urlfield enahancement (keystonejs#4856) * add thumb option support to url type * do not fix the height of form input since it the value can be out of bound
frapan
pushed a commit
to frapan/keystone
that referenced
this pull request
May 2, 2019
* tag 'v4.0.0' of https://github.com/keystonejs/keystone: bumped version 📣🎉 updating package bundle Reviewed Getting Started documentation (keystonejs#4721) Update to multer 1.3.1 and automatically clean uploaded files (keystonejs#4704) Minor fixes and improvements to the location field type (keystonejs#4455) Improve sanity checking for signin "from" param fixed typo added semver notations to dependencies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
FIxed spelling, grammar and broken link issues with the Getting Started documentation.
Description of changes
Related issues (if any)
Testing
npm run test-allran successfully.