octopress 3.0.8 → 3.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 863a0a4ca9a73f9fd15fafbc507522a47b98f702
-  data.tar.gz: 50fd4475631a81a88de3c3955fb045e1918daa9a
+  metadata.gz: 8a5d0577a968b736c201077dd3281c29361321ff
+  data.tar.gz: 3b5cec2f08534bfd66241977774ec3a3417af2c7
 SHA512:
-  metadata.gz: 6513217c9a43eaccd6affd8d2d866f71551cdc35a05e9cf68dd469a3fe7739c88a433f9c5d3c499533aff065500674c8bbd599e35573471f46c94e800da6582b
-  data.tar.gz: 233589e28d6eb546f156bb42d2bd3b0c0e3725279863929a3e3bdc62ebf16088ae97ce022f25feab9e9b4c1ddec636cead8c0aa0173130eac34862b0d848adf0
+  metadata.gz: 694d83bed6d87a03ac481e5bbd7c9ac1fce8e27f8c168dafe2735ebf1b25a246d806dfcace2fa1aed3bf4abe80a95f9633b2067bad23089abcbc6ccadeacf6aa
+  data.tar.gz: 2ff09c7cc7bcd5c66f9797392b3c80421cab42965cad8adcb4dc51600a6482f2b88e2220c044d9a6501ddd364cd9c9663a6339fbec36189255c119eb0e1f9331

data/CHANGELOG.md

@@ -1,6 +1,9 @@
 # Changelog
 
-### 3.0.8 (2015-06-18)
+### 3.0.9 (2015-06-18)
+- Documentation improvements
+
+### 3.0.8 (2015-06-17)
 - Added documentation for Octopress's deploy project.
 
 ### 3.0.7 (2015-06-01)

data/README.md

@@ -184,7 +184,7 @@ $ octopress unpublish some post
 Just like the publish command, you can either pass a path or a search string to match the file name. If more than one match is found, you
 will be prompted to select from a menu of posts.
 
-### Templates for Posts and pages
+#### Templates for Posts and pages
 
 Octopress post and page templates look like this.
 
@@ -245,10 +245,20 @@ $ octopress isolate kittens                        # Move post matching search
 
 In the third example, if multiple posts match the search a prompt will ask you to select a post from a menu.
 
-### Deploy
+### Deploying your site
 
 The Octopress gem comes with [octopress-deploy](https://github.com/octopress/deploy) which allows you to easily deploy your site with Rsync, on S3 or Cloudfront, to GitHub pages, or other Git based deployment hosting platforms.
 
+Once you've built your site (with `jekyll build`) you can deploy it like this:
+
+```
+$ octopress deploy
+```
+
+This reads a `_deploy.yml` configuration and deploys your site. Read below to learn how Octopress can generate a deployment configuration file for you.
+
+Deploy has a few commands you should know.
+
 | Commands                                   | Description                                                        |
 |:-------------------------------------------|:-------------------------------------------------------------------|
 | `octopress deploy`                         | Deploy your site (based on the `_deploy.yml` configuration)        |
@@ -256,20 +266,22 @@ The Octopress gem comes with [octopress-deploy](https://github.com/octopress/dep
 | `octopress deploy pull [DIR]`              | Pull down your site into a local directory.                        |
 | `octopress deploy add-bucket <NAME>`       | (S3 only) Add a bucket using your configured S3 credentials.       |
 
-#### Deploy configuration
 
-First set up a configuration file for your deployment method. For Git based deployment, pass the repository url. For S3 and Rsync, no arguments are necessary.
+#### Generate Deployment configuration
+
+**Remember to add your configuration to `.gitignore` to be sure
+you never commit sensitive information to your repository.**
+
+
+Octopress can generate a deployment configuration file for you using the `octopress deploy init` command.
 
 ```
-$ octopress deploy init git git@github.com:user/project
 $ octopress deploy init s3
 $ octopress deploy init rsync
+$ octopress deploy init git git@github.com:user/project
 ```
 
-This will generate a `_deploy.yml` file in your current
-directory which you can edit to add any necessary configuration.
-**Remember to add your configuration to `.gitignore` to be sure
-you never commit sensitive information to your repository.**
+This will generate a `_deploy.yml` file in your current directory which you can edit to add any necessary configuration.
 
 If you like, you can pass configurations as command line options. To see specific options for any method, add the `--help` flag.
 For example to see the options for configuring S3:
@@ -278,33 +290,19 @@ For example to see the options for configuring S3:
 $ octopress deploy init s3 --help
 ```
 
-#### Deploy your site
-
-Change the deployment configuration however you like, then build and deploy your site.
+If you want to publish your site to a staging server, you can create a second configuration. For example, to setup rsync for a staging site, you'd do this.
 
 ```
-$ jekyll build      # if you haven't yet
-$ octopress deploy
+$ octopress deploy init rsync --config _staging.yml
 ```
 
-This will read your `_deploy.yml` configuration and deploy your
-site. If you like, you can specify a configuration file.
+After modifying the configuration file, you can deploy your site to it like this:
 
 ```
 $ octopress deploy --config _staging.yml
 ```
 
-#### Pull down your site
-
-With the `pull` command, you can pull your site down into a local directory.
-
-```
-$ octopress deploy pull [DIR]
-```
-
-Mainly you'd do this if you're troubleshooting deployment and you want to see if it's working how you expected.
-
-##### Git Deployment Configuration
+#### Git Deployment Configuration
 
 Only `git_url` is required. Other options will default as shown below.
 
@@ -317,7 +315,7 @@ Only `git_url` is required. Other options will default as shown below.
 | `deploy_dir`  | Directory where deployment files are staged      | .deploy        |
 | `remote`      | Name of git remote                               | deploy         |
 
-##### Rsync Deployment Configuration
+#### Rsync Deployment Configuration
 
 | Config         | Description                                       | Default
 |:---------------|:--------------------------------------------------|:---------------|
@@ -398,24 +396,15 @@ If you prefer, you can store AWS access credentials in environment variables ins
 
 Note: configurations in `_deploy.yml` will override environment variables so be sure to remove those if you decide to use environment variables.
 
-#### Add a new bucket
+### Pull down your site
 
-If your AWS credentials are properly configured, you can add a new bucket with this command.
+With the `pull` command, you can pull your site down into a local directory.
 
 ```
-$ octopress deploy add-bucket <NAME>
+$ octopress deploy pull [DIR]
 ```
 
-This will connect to AWS, create a new S3 bucket, and configure it for static website hosting. This command can use the settings in your deployment configuration or you can pass options to override those settings.
-
-| Option        | Description                                      | Default
-|:--------------|:-------------------------------------------------|:---------------|
-| `--region`    | Override the `region` configuration              |                |
-| `--index`     | Specify an index page for your site              | index.html     |
-| `--error`     | Specify an error page for your site              | error.html     |
-| `--config`    | Use a custom configuration file                  | _deploy.yml    |
-
-You'll only need to pass options if you want to override settings in your deploy config file.
+Mainly you'd do this if you're troubleshooting deployment and you want to see if it's working how you expected.
 
 ## Contributing
 

data/lib/octopress/version.rb

@@ -1,3 +1,3 @@
 module Octopress
-  VERSION = "3.0.8"
+  VERSION = "3.0.9"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octopress
 version: !ruby/object:Gem::Version
-  version: 3.0.8
+  version: 3.0.9
 platform: ruby
 authors:
 - Brandon Mathis