Our documentation has had an overhaul, and some of the URLs have changed. This updates the links to be correct according to the latest version of the docs.
refs #7421
- simplify README.md to be more use-case oriented and point to https://docs.ghost.org where appropriate
- remove majority of CONTRIBUTING.md content as it now lives at https://docs.ghost.org/contributing
- update adapter guide links in `content/adapters/README.md`
no issue
- earlier versions of yarn result in slightly different yarn.lock files that can cause issues with modified files when running `grunt master` and similar
refs #8235
Usage:
- for existing development setups: `grunt symlink` (will create the pre-commit symlink)
- for fresh development setups: `npm run init` (symlinking happens as part of the typical set up)
- ✨ Added pre-commit hook to handle submodules
- Checks to see if there are any submodules about to be committed
- Output matches closely to `git st` to make it easy to read
- Requires interaction from the committer to accept that this really should be committed
- ✨ Use grunt symlink to register githooks
- Grunt symlink will make a link to the pre-commit hook
- It ONLY does this if there isn't already a pre-commit hook, so won't overwrite anything
- It does this as part of npm run init, not grunt init, because a release repo would NEVER want this
- This is a dev tool, that configures the repo for development
no issue
- use `yarn install` instead of `npm install` in grunt tasks
- remove `grunt deps` and `grunt shell:{shrinkwrap/prune/dedupe}` tasks as they are not needed when using `yarn`
- set `options.npmPath` to `yarn` for subgrunt so it doesn't use `npm install` automatically
- don't remove client contributors files in `grunt clean` - those files are now manually created and should be kept
* 🛠 switch to using yarn in our Grunt tasks
* 🛠 use yarn for `npm run init`, update README
No Issue
* You may have had a reason for it to be the way it was, but this
updates it to be the actual commands rather than just close to actual
commands
I'm not convinced this is going to work, but it's an attempt to get more people asking install questions in Slack rather than opening github issues. Also fix broken link to Ghost(Pro) further down, Github stripped the HTML so converted to Markdown.
- Contributing ref link was being gratuitously double-linked to, nixed that.
- Changed grammar which is ambiguous between US/UK colloquialism.
- Moved contributing/troubleshooting reference to "installing from git" heading rather than "quickstart" subheading
- Standardised 2-linebreaks between Markdown headings
