Ghost 1.0.0 Documentation

This issue is a placeholder for keeping a list of documentation we’re going to need to write/rewrite for Ghost 1.0.0.

pre-tasks from meeting

• help.ghost.org - stays as is
• themes.ghost.org stays as it
• docs.ghost.org - die, but it will be the new developers/core documentation
• http://support.ghost.org - migrate to docs.ghost.org @cobbspur
• [ ] academy.ghost.org - die (move to help.ghost.org) - @frantzypants will care
• move github wiki to docs.ghost? (except of contributing.md, which links to readme) which includes tooling, apps, how to develop with server/client etc @kevinansfield @kirrg001
• @sebgie support.ghost.org dies

required

@AileenCGN

• http://themes.ghost.org/ + documentation for package.json theme validation
• from #8348: additional theme documentation updates
• new error templates. base / 5xx errors should never use any helpers other than asset.
• mail config
• ghost.org/developers shows API, themes, core (developers) and docs.ghost.org

@kirrg001

• How to use the new config (http://support.ghost.org/config)
• How to use the new CLI installer
• improve working with Ghost 1.0 guide
• remove remote authentication configuration option in our docs/wiki
• ?formats query param
• update ghost-server.js -> change Alpha to Beta
• go over LTS branch and update broken links e.g. in the content folder or readme
• Update installation guide for self hoster
• update storage and scheduling guides - adapter location
• https://dash.readme.io/legacy/project/ghost/v1.0.0/docs/how-to-setup-ssl-for-self-hosted-ghost - what about this page? stay as is
• https://dash.readme.io/legacy/project/ghost/v1.0.0/docs/how-to-setup-ssl-for-self-hosted-ghost - what about this page? stay as is
• https://docs.ghost.org/docs/troubleshooting-guide

@kevinansfield

• cleanup wiki pages
• document grunt master
• yarn run init -> explain that this command is only for initial setup + warning on feature branches!
• grunt file: go over documentation and double check if we have old documentation for 1.0 for old commands
• grunt dev documentation to explain when/why to use the individual commands
• Add client documentation for developing
• https://www.google.co.uk/search?client=safari&rls=en&q=site:support.ghost.org&ie=UTF-8&oe=UTF-8&gfe_rd=cr&ei=YOgrWdioG-_GXqvOvvgO - replace and then redirect the old content (the new content should live on another readme.io site)
• Update README master + remove alpha wording
• Update contributing guide master
• highlight github README (GHOST PRO) section

@cobbspur

• http://support.ghost.org/supported-node-versions/ - LTS vs. 1.0
• documentation suggestions: https://github.com/TryGhost/Ghost/issues/8421
• server logs - explain server logs and logging - support.ghost.org + wiki?
• how to migrate from LTS to 1.0 - page?
• https://support.ghost.org/v1-0-alpha to https://support.ghost.org/v1-0-beta?
• manage alpha/beta pages on General category

@frantzypants

• help.ghost.org to the list - the settings screens and anything with the editor will need updating.

soon

• rework main contributing guide
• Where is says {{#if image}}, it should be {{#if feature_image}}. Instead of should be - https://themes.ghost.org/docs/if
• https://ghost.slack.com/archives/C04CUS2R3/p1497969873979042
• there are for sure old articles for https://www.ghostforbeginners.com, which is always number one in the search result in google -> I (Aileen) sent a message, to David B. -> replied that he’ll start updating his posts now
• document how to use env variables for config!!! look at github issue/pr’s you will something useful or slack has old conversations as well
• document how to debug config output
• #8633
• Reactivate/Rewrite using Ghost as NPM module for docs.ghost.org 1.0
• https://docs.ghost.org/v1.0.0/docs/how-to-upgrade-ghost - enable this and rewrite to use the CLI
• ensure that all model properties are correctly documented e.g. author.feature_image is not valid, but the theme developer must be able to lookup the valid properties in the docs
• http://themes.ghost.org/docs/changelog#ghost-100-beta - update if image deprecations are fatal and add more stuff in the chanelog if needed

[ErisDS]

This would defeat the point of having an “official” stack.

What we are trying to achieve is not having the core team spending large amounts of time trying to add support for every possible self-hoster setup & adding a ridiculous QA overhead that literally stops us from being able to do anything ever. Instead, we have one stack that we support for self-hosters and that is Ubuntu 16.04 + MySQL + Nginx + Systemd.

You are more than welcome to ignore the official recommendation, but in that case you would need to refer to community documentation not official documentation.

[frantzypants]

Thinking we should add updating help.ghost.org to the list - the settings screens and anything with the editor will need updating.