Commit Graph

101 Commits

Author SHA1 Message Date
Katharina Irrgang 4554bbcba7
Overhauled README.md (#9784)
no issue

- Significantly improved README.md
- Highlight our cli install
- Nicer formatting of links
- And much, much more...
- use V1 docs links for master
2018-08-14 00:35:15 +02:00
kirrg001 132df78940 Updated docs links
refs #9742

- Ghost 2.0 is coming
- all doc links in 1.0 must use concrete links e.g. docs.ghost.org/v1 or themes.ghost.org/v1.23.0/
- if we release Ghost 2.0, docs.ghost.org will show 2.0 docs
2018-07-20 23:49:16 +02:00
Ameya Shenoy e5335acdb6 Fixed links in README (#9697)
no issue

- themes.ghost.org was incorrect
- updated links to use https
- replace dev.ghost.org by blog.ghost.org
2018-06-21 20:56:51 +02:00
Hannah Wolfe a22b6fb92e Slack -> Forum
- replacing references to slack with forum
2018-04-02 17:12:09 +01:00
John O'Nolan 5cb41dbcd9 2018 2018-01-02 21:44:41 +00:00
John O'Nolan d04e0f3a0c Remove wishlist links (#8981)
No issue

The uservoice wishlist has been pretty inactive and neglected for quite a long time now. Removing links to it from Ghost is the first step toward retiring it. We're still listening to user feedback in order to determine the Ghost roadmap, but simplifying the process around it.
2017-09-07 09:04:33 +02:00
Vikas 8606ea22a2 Normalize docs URLs (#8949)
no issue

v1.0.0 is no longer the standard in the docs, so I updated all of the URLs containing it with v1
Note: I tried squashing commits, but failed. I'll try again in the future with throwaway changes
Secondary Note: I tested most of the URLs listed and got no 404s!
2017-08-31 11:45:59 +02:00
John O'Nolan cf093c767c 📖 Remove broken link from Readme.md (#8788)
closes https://github.com/TryGhost/Ghost/issues/8558

Don't need the deep-link, not worth the hassle. The other docs mentioned in the issue are complete
2017-07-31 16:01:58 +04:00
John O'Nolan 923f982fce Update readme
Spacing adjustments
2017-07-31 09:50:45 +04:00
John O'Nolan 2a9f8e0906 Updated readme
New screenshot + link to trademark policy
2017-07-31 09:49:24 +04:00
Hannah Wolfe 300465ffec 📖 Update docs links
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.
2017-07-26 23:27:23 +04:00
kirrg001 99d7cdf0ab 🔥 remove flux warning
no issue

- 1.0.0-rc.1 was released
- check it out https://dev.ghost.org/ghost-1-0-0-rc-1/
2017-07-11 20:25:09 +02:00
Katharina Irrgang 1813d1815d recommend node v6 (#8674)
no issue

- see https://docs.ghost.org/docs/supported-node-versions
- add supported node versions link to README
- run coverage for node v6
2017-07-11 14:05:38 +01:00
Kevin Ansfield 1a58a4757c 📖 update readme links
refs #8558
- updates broken links so they go to relevant pages that will soon have correct content
2017-06-08 20:45:16 +01:00
Kevin Ansfield 0f82e49159 📖 1.0.0 update for README.md and CONTRIBUTING.md (#8539)
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`
2017-06-08 17:05:27 +01:00
Katharina Irrgang 47b24b2d4f 🎨 Using yarn instead of npm according to the paragraph above it (#8475)
no issue
- original PR: https://github.com/TryGhost/Ghost/pull/8288
2017-05-23 17:24:24 +01:00
Katharina Irrgang 2b27cf69dc 🎨 add min version of yarn to our readme (#8452)
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
2017-05-12 08:53:53 +01:00
Hannah Wolfe e9a537004b Added pre-commit hook to handle submodules (#8302)
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
2017-04-13 08:26:48 +01:00
Kevin Ansfield 1cb1ea105c 🛠 switch to using yarn in our Grunt tasks (#8261)
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
2017-04-04 11:47:12 +01:00
Katharina Irrgang 76fd1264a8 📖 Update README installation instructions (#8175)
- add contributing workflow link already
- i would suggest we merge this PR if the workflow guide was reviewed
2017-03-23 16:02:21 +00:00
Katharina Irrgang f4a68a2e52 🔥 remove gulp (#8159)
* remove gulpfile
* remove gulp dependencies
* Update README.md
2017-03-14 14:20:53 +00:00
Hannah Wolfe ffcf7d1d83 Update install instructions to include global deps
- knex-migrator and gulp are required
2017-02-22 12:45:28 +00:00
David Balderston a64b8f0449 Update Install Instructions (#8034)
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
2017-02-22 07:21:54 +00:00
John O'Nolan 952fac6be4 Update alpha install instructions 2017-02-15 22:02:56 +07:00
Katharina Irrgang 12c0ca3d2f 🔥 remove knex-migrator from README (#7884)
no issue

- we will update the instructions for 1.0 before we release 1.0
2017-01-24 18:30:22 +01:00
John O'Nolan 56f30e9e0d 2017 (#7819)
* Dat copyright
* bro do u even 2017
2017-01-04 10:05:57 +00:00
Katharina Irrgang 8d8d7bdb26 knex migrator (#7565)
refs #7489
- remove sephiroth
- use knex migrator npm
- goodbye bootup script
- 🎨  update README
- 🎨  knex migrator @ 0.0.2
2016-10-17 13:50:29 +01:00
John O'Nolan fa07cc7f52 Update readme for 1.0 😱 (#7405) 2016-09-20 15:59:34 +01:00
kirrg001 6275fdbb25 🔥 remove node 0.10 support, add node 6 support
refs #6899, refs #7098
2016-09-20 15:59:34 +01:00
Hannah Wolfe ee1f4fdbdd Recommend Node v4 & use as default (#7102)
refs #7098

- Use Node.js v4 as our default build environment
- Add Node.js v6 as an allowed failure
- Update contributor guidelines and readme
- Fix issue with branch exceptions
2016-07-15 12:36:15 -06:00
Hannah Wolfe 8b53308f10 Update location of download page
- https://ghost.org/downloads/ is now https://ghost.org/developers/
2016-04-13 19:49:07 +01:00
Jeremiah Hoyet 979ca4039d Fixes README.md link to CONTRIBUTING.md 2016-02-20 08:25:20 -05:00
Hannah Wolfe d593425147 README: supported node version info update 2016-02-12 11:39:13 +00:00
Naoya Kanai 4834cb436d Support Node v4 LTS semver-minor releases
Fixes #6473
- Replace Node v4.2 with v4 in Travis config
- Replace ~4.2.0 with ^4.2.0 in engines to support semver-minor bumps in LTS line
2016-02-12 01:37:27 +09:00
John O'Nolan dfb45761b8 Update copyright year 2016-01-03 15:01:56 +02:00
Sean Hussey 39b7b3101f Fixing a small typo in the README. 2015-12-23 15:36:44 -05:00
Hannah Wolfe 8dbef11bc5 Updated node version text in README.md
no issue

- update README to match the new version support
2015-12-01 14:09:16 +08:00
John O'Nolan 1add453733 Remove forum mentions 2015-09-29 13:10:04 +02:00
Rafael Corrêa Gomes 69ba0922b2 Correct bold string 2015-08-27 20:48:15 -03:00
John O'Nolan 344bcfa693 Update readme with Slack support info
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.
2015-07-01 09:42:36 +02:00
John O'Nolan 832084f66f Add DigitalOcean infrastructure details 2015-06-16 10:50:06 +01:00
John O'Nolan 3e67014c23 Added new Slack team details
BECAUSE INTERNET
2015-04-15 14:59:25 +03:00
Hannah Wolfe e5ed9c6fed Re-add #getting-started anchor
Install errors (from not building files) point here.
2015-03-19 12:52:48 +00:00
JonathanKryza a4109f3edf Fixed broked Support link
Changed ghost.org/support to http://support.ghost.org/.

Thanks to http://derecho.elijah.cs.cmu.edu:8585/@top for finding the broken link.
2015-03-13 14:07:00 -05:00
John O'Nolan 29baee24ab Readmeeeeee 2015-03-13 14:03:40 +02:00
Hannah Wolfe 338e52f70a README & CONTRIBUTING updates
- update compatibility info
- better information on releases
- add ideas.ghost.org to feature request section of contrib
2015-03-09 20:54:00 +00:00
Hannah Wolfe 8553644760 Add compatibility notice to README 2015-02-28 16:46:16 +00:00
Jimmy Hsu 0c429c3aee Minor grammatical fixes to README.md
Added an Oxford comma for consistency, and clarified a slightly awkward sentence.
2015-02-14 17:09:14 -08:00
John O'Nolan bd1211da5d Update copyright 2015-01-02 16:11:13 +02:00
John O'Nolan e62ce6c5cb Removed double link, moved contributing ref.
- 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
2014-12-29 17:48:06 +02:00