TomWFox/Parse-Docs

New unified docs for the Parse Platform

Parse Docs

These new docs are far from finished the current ones can be found here. Any help in completing these docs is much appreciated - see the discussion about these new docs and the migration guide.

These are the markdown sources for all of the Parse SDK guides. The content for the guides is stored in this repo, these docs have been created with Slate which then generates a static site that is hosted on GitHub Pages.

Installation

Prerequisites

You're going to need:

• Linux or macOS — Windows may work, but is unsupported.
• Ruby, version 2.3.1 or newer
• Bundler — If Ruby is already installed, but the bundle command doesn't work, just run gem install bundler in a terminal.

Getting Set Up

1. Fork this repository on GitHub.
2. Clone your forked repository (not our original one) to your hard drive with git clone https://github.com/YOURUSERNAME/Parse-Docs.git
3. cd Parse-Docs
4. Initialize and start the Parse Docs. You can either do this locally, or with Vagrant:

# either run this to run locally
bundle install
bundle exec middleman server

# OR run this to run with vagrant
vagrant up

You can now see the docs at http://localhost:4567. Whoa! That was fast!

Now that the Parse Docs are all set up on your machine, you'll probably want to learn more about editing Slate markdown.

Editing the Docs

Each top level section is held in a separate markdown file in the source > includes folder. Within a sections markdown file are the contents for both the middle view and code view on the right. Please remember when making changes to the docs that unless noted the copy needs to apply to all of the Parse client SDKs.

Adding a new section

If you would like to add a new section first create a file in the source > includes folder, use existing files as a template. The file name should start with an underscore, be all lowercase, with dashes separating words and the .md file format.

Then add the new section in the index.html.md file under includes as the name of the section file with the underscore removed.

Questions? Need Help? Found a bug?

Found a bug with upstream Slate? Go ahead and submit an issue. And, of course, feel free to submit pull requests with bug fixes or changes to the dev branch.