From 66d91132b338d80b527a5c1cdbf807b10381ebed Mon Sep 17 00:00:00 2001 From: jayeshmahadkar <44085080+jayeshmahadkar@users.noreply.github.com> Date: Fri, 2 Oct 2020 10:38:33 +0530 Subject: [PATCH] Update README.md --- README.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 5cc72f6..3bac5e2 100644 --- a/README.md +++ b/README.md @@ -13,14 +13,14 @@ activecell.com ============== -The site is delivered in static form using the following tools/services: +The site is delivered in static form using the following tools/services:- -* [jekyll](http://github.com/mojombo/jekyll) for site generation based on markdown and templates -* [jammit](http://documentcloud.github.com/jammit/) and [jammit plugin for jekyll](https://gist.github.com/1224971) for the asset pipeline -* [s3cmd](http://s3tools.org/s3cmd) for sync to Amazon S3 -* [Amazon S3](http://aws.amazon.com/s3/) for static file storage -* [Amazon CloudFront](http://aws.amazon.com/cloudfront/) as a Content Delivery Network -* [dnsimple](http://dnsimple.com) for world-class dns +* [jekyll](http://github.com/mojombo/jekyll) for site generation based on Markdown and Templates. +* [jammit](http://documentcloud.github.com/jammit/) and [jammit plugin for jekyll](https://gist.github.com/1224971) for the asset pipeline. +* [s3cmd](http://s3tools.org/s3cmd) for sync to Amazon S3. +* [Amazon S3](http://aws.amazon.com/s3/) for static file storage. +* [Amazon CloudFront](http://aws.amazon.com/cloudfront/) as a Content Delivery Network. +* [dnsimple](http://dnsimple.com) for world-class dns. More information can be found in [this post](http://www.maxmasnick.com/2012/01/21/jekyll_s3_cloudfront/) by Max Masnick. @@ -28,25 +28,25 @@ The reason for the move to these tools was simple. Originally, we had an entirely static site, and it was a bear to maintain. When we want to change a footer element, it needed to be updated in 30 places. When we had a new post, it needed to be created based on an existing page. Woof. -Then we moved to Wordpress, and all those problems went away, but they created a thousand other problems around performance and maintenance. The site kept going down for one reason or another, and it was clear we had a complicated answer to a simple problem. +Then we moved to Wordpress, and all those problems went away, but they created a thousand other problems around performance and maintenance. The Site Kept going down for one reason or another, and it was clear we had a complicated answer to a simple problems. Jekyll provides a middle ground. It's simple and source-controlled. It's templated, and it works with s3 simply and easily. With the plugins and S3/Cloudfront, we get top-tier performance for all our non-html assets (js, css, images). -Awesome. +Awesome for anyone ... Just Do It. -Contributing & Deploying +Contributing & Deployment ------------------------ -Contributing is easy: +Contributing is easy:- -1. Clone the repo to your local machine -1. Make sensible changes +1. Clone the repo to your local machine. +1. Make sensible changes. 1. Add any new images to /assets/img and reference like src="{{ 'assets/img/new_img.jpg' | cdn }}" -1. Edit CSS/JS as required and ensure any new JS/CSS are listed in _assets.yml for packaging +1. Edit CSS/JS as required and ensure any new JS/CSS are listed in _assets.yml for packaging. 1. Run `jekyll --server --auto` to view the generated site locally at localhost [http://localhost:4000/](http://localhost:4000/) and to automatically re-generate pages based on your changes -1. Run 'rake deploy' to deploy the generated site to production -1. Commit changes push to origin +1. Run 'rake deploy' to deploy the generated site to production. +1. Commit changes push to origin. Note: Hotfixes and minor changes can be pushed directly to master. Anything heavy, or if there's even a question, and please submit a pull request for the update. -The site will continue to evolve, but see [jekyll documentation](http://github.com/mojombo/jekyll) for information about how to generate content for the site. \ No newline at end of file +The site will continue to evolve, but see [jekyll documentation](http://github.com/mojombo/jekyll) for information about how to generate content for the site.