Merge pull request #132 from jekyll/pre-release-docs-refresh

Prepare the docs for outside contributors

Author: benbalter

CONTRIBUTING.md

@@ -0,0 +1,69 @@
+Interested in contributing to Jekyll Admin? We’d love your help. Jekyll Admin is an open source project, built one contribution at a time by users like you.
+
+## Where to get help or report a problem
+
+If you think you've found a bug with Jekyll Admin, or if you'd like to propose a new feature check out the [list of open issues](https://github.com/jekyll/jekyll-admin/issues) and if it's not there [open a new one](https://github.com/jekyll/jekyll-admin).
+
+## Ways to contribute
+
+* Add Jekyll Admin to an existing site. Does it work? Does it do what you'd expect? Anything else you'd like to see? If you have any suggestions, [open an issue](https://github.com/jekyll/jekyll-admin/issues/new)
+
+* Comment on some of the project’s [open issues](https://github.com/jekyll/jekyll-admin/issues/). Have you experienced the same problem? Know a work around? Do you have a suggestion for how the feature could be better?
+
+* Read through [the documentation](http://jekyll.github.com/jekyll-admin), and click the “improve this page” button, any time you see something confusing, or have a suggestion for something that could be improved.
+
+* Find an [open issue](https://github.com/jekyll/jekyll-admin/issues/) (especially those labeled `help-wanted`), and submit a proposed fix. If it’s your first pull request, we promise we won’t bite, and are glad to answer any questions.
+
+* Help evaluate [open pull requests](https://github.com/jekyll/jekyll-admin/pulls/), by testing the changes locally and reviewing what’s proposed.
+
+## Submitting a pull request
+
+### Pull requests generally
+
+* The smaller the proposed change, the better. If you'd like to propose two unrelated changes, submit two pull requests.
+
+* The more information, the better. Make judicious use of the pull request body. Describe what changes were made, why you made them, and what impact they will have for users.
+
+* Pull request are easy and fun. If this is your first pull request, it may help to [understand GitHub Flow](https://guides.github.com/introduction/flow/).
+
+* If you're submitting a code contribution, be sure to read the [code contributions](#code-contributions) section below.
+
+### Submitting a pull request via github.com
+
+Many small changes can be made entirely through the github.com web interface.
+
+1. Navigate to the file within [`jekyll/jekyll-admin`](https://github.com/jekyll/jekyll-admin) that you'd like to edit.
+2. Click the pencil icon in the top right corner to edit the file
+3. Make your proposed changes
+4. Click "Propose file change"
+5. Click "Create pull request"
+6. Add a descriptive title and detailed description for your proposed change. The more information the better.
+7. Click "Create pull request"
+
+That's it! You'll be automatically subscribed to receive updates as others review your proposed change and provide feedback.
+
+### Submitting a pull request via Git command line
+
+1. Fork the project by clicking "Fork" in the top right corner of [`jekyll/jekyll-admin`](https://github.com/jekyll/jekyll-admin).
+2. Clone the repository locally `git clone https://github.com/<you-username>/jekyll-admin`.
+3. Create a new, descriptively named branch to contain your change ( `git checkout -b my-awesome-feature` ).
+4. Hack away, add tests. Not necessarily in that order.
+5. Make sure everything still passes by running `script/cibuild` (see [the tests section](#running-tests-locally) below)
+6. Push the branch up ( `git push origin my-awesome-feature` ).
+7. Create a pull request by visiting `https://github.com/<your-username>/jekyll-admin` and following the instructions at the top of the scree
+
+## Proposing updates to the documentation
+
+We want the Jekyll Admin documentation to be the best it can be. We've open-sourced our docs and we welcome any pull requests if you find it lacking. Any time you propose a code change, you should also include updates to the documentation and tests within the same pull request.
+
+If your contribution changes any Jekyll Admin behavior, make sure to update the documentation. Documentation lives in the `/docs` folder (spoiler alert: it's a Jekyll site!). If the docs are missing information, please feel free to add it in. Great docs make a great project. Include changes to the documentation within your pull request, and once merged, the site will be updated.
+
+### How to submit changes
+
+You can find the documentation in the [`/docs`](https://github.com/jekyll/jekyll-admin/tree/master/docs) directory. See the section above, [submitting a pull request](#submitting-a-pull-request) for information on how to propose a change.
+
+### Previewing changes locally
+
+1. `script/bootstrap`
+2. `script/docs-server`
+3. Open [localhost:4000/jekyll-admin](http://localhost:4000/jekyll-admin) in your browser

README.md

@@ -0,0 +1,22 @@
+[![Build Status](https://travis-ci.org/jekyll/jekyll-admin.svg?branch=master)](https://travis-ci.org/jekyll/jekyll-admin)
+
+A Jekyll plugin that provides users with a traditional CMS-style graphical interface to author content and administer Jekyll sites. The project is divided into two parts. A Ruby-based HTTP API that handles Jekyll and filesystem operations, and a Javascript-based front end, built on that API.
+
+![screenshot of Jekyll Admin](https://cloud.githubusercontent.com/assets/282759/17258537/62e23ed6-5595-11e6-89b0-31c787f0492a.png)
+
+## Installation
+
+Refer to [Install Plugins](https://jekyllrb.com/docs/plugins/#installing-a-plugin) in Jekyll docs and install the `jekyll-admin` plugin as you would normally by adding `jekyll-admin` to your Gemfile and `_config.yml`'s `gems` list.
+
+## Usage
+
+1. Start Jekyll as you would normally (`bundle exec jekyll serve`)
+2. Navigate to `http://localhost:4000/admin` to access the administrative interface
+
+## Contributing
+
+Interested in contributing to Jekyll Admin? We’d love your help. Jekyll Admin is an open source project, built one contribution at a time by users like you. See [the contributing instructions](CONTRIBUTING.md), and [the development docs](http://jekyll.github.io/jekyll-admin/development/) for more information.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

README.md

@@ -0,0 +1,25 @@
+---
+layout: default
+---
+
+<article class="post">
+
+  <header class="post-header">
+    <h1 class="post-title">{{ page.title | escape }}</h1>
+    {% if page.description %}
+      <h2 class="lede">{{ page.description }}</h2>
+    {% endif %}
+  </header>
+
+  <div class="post-content">
+    {{ content }}
+  </div>
+
+</article>
+
+<p>
+  <em>
+    Found a mistake? See something that can be made better? These docs are open source. <br />
+    Please help <a href="https://github.com/{{ site.github.repository_nwo }}/edit/master/{{ page.path }}">improve this page</a>.
+  </em>
+</p>

docs/_layouts/page.html

@@ -1,131 +1,163 @@
-# Action Creators
-Actions are payloads of information that send data from the application to the store.
+---
+title: Actions
+permalink: /frontend/actions/
+description: Actions are payloads of information that send data from the application to the store.
+---
 
 ## Configuration
 
 ### `fetchConfig`
+
 Async action for fetching Jekyll project configuration (`_config.yml`)
 
 ### `putConfig(config)`
+
 Async action for updating Jekyll project configuration
 
 ### `onEditorChange`
-Action for notifying whether the YAML editor has changed after last update
 
+Action for notifying whether the YAML editor has changed after last update
 
 ## Pages
 
 ### `fetchPages`
+
 Async action for fetching an array of page objects.
 
 ### `fetchPage(id)`
+
 Async action for fetching the requested page.
 
 ### `putPage(id)`
+
 Async action for creating/updating the requested page. The edited/new content comes
 from `state.metadata`
 
 ### `deletePage(id)`
-Async action for deleting the requested page.
 
+Async action for deleting the requested page.
 
 ## Collections
 
 ### `fetchCollections`
+
 Async action for fetching an array of the registered collections (including posts).
 
 ### `fetchCollection(collection_name)`
+
 Async action for fetching information about the requested collection
 
 ### `fetchDocuments(collection_name)`
+
 Async action for fetching an array of documents corresponding to the requested collection. The response does not include the document body.
 
 ### `fetchDocument(collection_name, id)`
+
 Async action for fetching the requested document. The response includes the document body.
 
 ### `putDocument(id, collection_name)`
+
 Async action for creating/updating the requested document. The response includes the document body. The updated content comes from `state.metadata`
 
 ### `deleteDocument(collection_name, id)`
-Async action for deleting the document from disk.
 
+Async action for deleting the document from disk.
 
 ## Metadata
 
 ### `storeContentFields(meta)`
+
 Action that puts the current document's meta in the redux store.
 
 ### `addField(namePrefix)`
+
 Action that adds empty value to given path in metadata.
 
 ### `removeField(namePrefix, key)`
+
 Action that removes the field with the given `key`. `key` can be object key or
 array index.
 
 ### `updateFieldKey(namePrefix, fieldKey, newKey)`
+
 Action that updates the key of the field with given path in metadata.
 
 ### `updateFieldValue(nameAttr, value)`
+
 Action that updates the value of the field with given path in metadata.
 
 ### `moveArrayItem(namePrefix, srcInd, targetInd)`
+
 Action that moves the array item of the field with given path in metadata
 to the target index.
 
 ### `convertField(nameAttr, convertType)`
+
 Action that converts the field to the given type.
 
 ### `updateTitle(title)`
+
 Updates the content title when the input changes.
 
 ### `updateBody(body)`
+
 Updates the content body when the markdown editor changes.
 
 ### `updatePath(path)`
+
 Updates the content path when the input changes.
 
 ### `updateDraft(isDraft)`
-Updates the content visibility when the checkbox changes.
 
+Updates the content visibility when the checkbox changes.
 
 ## Static Files
 
 ### `fetchStaticFiles`
+
 Async action for fetching static files.
 
 ### `uploadStaticFiles(files)`
+
 Async action for uploading multiple static files at the same time.
 It encodes the uploaded `File` objects to `base64` before sending PUT request.
 
 ### `deleteStaticFile(filename)`
-Async action for deleting the requested static file.
 
+Async action for deleting the requested static file.
 
 ## Data Files
 
 ### `fetchDataFiles`
+
 Async action for fetching data files.
 
 ### `fetchDataFile(filename)`
+
 Async action for fetching the requested data file.
 
 ### `putDataFile(filename, data)`
+
 Async action for creating/updating the requested data file. It validates the given filename and data before the PUT request.
 
 ### `deleteDataFile(filename)`
+
 Async action for deleting the requested data file.
 
 ### `onDataFileChanged`
-Action for keeping track of the updated form fields.
 
+Action for keeping track of the updated form fields.
 
 ## Utils
 
 ### `search(input)`
+
 Action for storing search input from the user
 
 ### `validationError(errors)`
+
 Action for storing form errors.
 
 ### `clearErrors`
+
 Action for clearing form errors if any.