From 0f95626b2d4b0ffb8eb03093e9b615466b548dd8 Mon Sep 17 00:00:00 2001 From: udkumar Date: Fri, 21 Jul 2017 12:06:27 +0530 Subject: [PATCH 1/2] readme update --- README.md | 62 +++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 44 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 8fead72..26456d7 100644 --- a/README.md +++ b/README.md @@ -6,37 +6,63 @@ It has built in dynamic sitemap generation for **SEO** compliance. **Capistrano** default configuration is included that can be modified to fit your needs. ##Steps to deploy and build sites + ####1. Clone the project - git clone git://github.com/joshsoftware/ejosh.git + > $ git clone git://github.com/joshsoftware/ejosh.git + ####2. Install submodules - git submodule init - git submodule update -####3. Modify config/deploy.rb as per your need -####4. Deploy using cap deploy:cold (capistrano will deploy along with the submodules) + > $ git submodule init + > $ git submodule update + +####3. Modify config/deploy.rb as per your need. + +####4. Deploy using cap deploy:cold (capistrano will deploy along with the submodules). + ####5. Invoke the url http://:/admin + ####6. default user/password is admin/joshsoftware -####7. Configure the site by selecting "Site Configuration" menu -####8. Select layout and color from "Customize Layout" -####9. Go to "Content Management" to define content for the site + +####7. Configure the site by selecting "Site Configuration" menu. + +####8. Select layout and color from "Customize Layout". + +####9. Go to "Content Management" to define content for the site. + - Page Sections are like partials that can reused in any categories or pages. - - You can define tags to appear as tag clouds - - You define a category which can appear as sub-menus in a page - - You define page with meta tag keywords and add categories and/or page section to page + + - You can define tags to appear as tag clouds. + + - You define a category which can appear as sub-menus in a page. + + - You define page with meta tag keywords and add categories and/or page section to page. + ####10. Go to "Navigation Management" + - You can define what do be shown on header navigation bar and associate each item to a page. - - You similarly do it for footer + + - You similarly do it for footer. + - Some of the layout have a provision for quick link you can define those as well. - - You add the crawler codes that should be part of all of you pages (like google urchin) for SEO -####11. Open config/sitemap.yml and modify as per you requirment -####12. run rake sitemap:generate, it will create sitemap.xml and submit to google, yahoo and bing + + - You add the crawler codes that should be part of all of you pages (like google urchin) for SEO. + +####11. Open config/sitemap.yml and modify as per you requirment. + +####12. run rake sitemap:generate, it will create sitemap.xml and submit to google, yahoo and bing. + ####13. It has in-build dynamic sitemap generation. + ####14. Click "Go Live" from "Site Configuration" -####15. You site is up and running with SEO compliance -####16. User management, manage different type users + +####15. You site is up and running with SEO compliance. + +####16. User management, manage different type users. + ####17. You can select "Plugin" and add or remove the plugins. There are various plugins available to manage day-to-day employee managment, leave managment, etc. ##Contact -Contact **support@joshsoftware.com** for any queries and issues +Contact **[support@joshsoftware.com](mailto:support@joshsoftware.com)** for any queries and issues. + Report bugs on [lighthoust](http://joshsoftware.lighthouseapp.com/projects/44901-ejosh/tickets) From bf2aa05e6ab27c036046dfc644438dc7bee27e58 Mon Sep 17 00:00:00 2001 From: udkumar Date: Fri, 21 Jul 2017 12:10:58 +0530 Subject: [PATCH 2/2] readme syntax correction --- README.md | 43 +++++++++++++++++++++++-------------------- 1 file changed, 23 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 26456d7..7dad639 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,35 @@ -#eJOSH +# eJOSH eJOSH is a **custom CMS**. eJOSH is **ruby on rails** application that comes with a list of pre-defined layouts and color themes and it is ready to use to build your website or to use for your intranet with it's available plugins (**employee management, Leave management, Timesheet management, etc..**) and it has built in user management (with 3 different roles). It has built in dynamic sitemap generation for **SEO** compliance. **Capistrano** default configuration is included that can be modified to fit your needs. -##Steps to deploy and build sites +## Steps to deploy and build sites + +1. Clone the project -####1. Clone the project > $ git clone git://github.com/joshsoftware/ejosh.git -####2. Install submodules +2. Install submodules + > $ git submodule init + > $ git submodule update -####3. Modify config/deploy.rb as per your need. +3. Modify config/deploy.rb as per your need. -####4. Deploy using cap deploy:cold (capistrano will deploy along with the submodules). +4. Deploy using cap deploy:cold (capistrano will deploy along with the submodules). -####5. Invoke the url http://:/admin +5. Invoke the url http://:/admin -####6. default user/password is admin/joshsoftware +6. default user/password is admin/joshsoftware -####7. Configure the site by selecting "Site Configuration" menu. +7. Configure the site by selecting "Site Configuration" menu. -####8. Select layout and color from "Customize Layout". +8. Select layout and color from "Customize Layout". -####9. Go to "Content Management" to define content for the site. +9. Go to "Content Management" to define content for the site. - Page Sections are like partials that can reused in any categories or pages. @@ -36,7 +39,7 @@ It has built in dynamic sitemap generation for **SEO** compliance. - You define page with meta tag keywords and add categories and/or page section to page. -####10. Go to "Navigation Management" +10. Go to "Navigation Management" - You can define what do be shown on header navigation bar and associate each item to a page. @@ -46,21 +49,21 @@ It has built in dynamic sitemap generation for **SEO** compliance. - You add the crawler codes that should be part of all of you pages (like google urchin) for SEO. -####11. Open config/sitemap.yml and modify as per you requirment. +11. Open config/sitemap.yml and modify as per you requirment. -####12. run rake sitemap:generate, it will create sitemap.xml and submit to google, yahoo and bing. +12. run rake sitemap:generate, it will create sitemap.xml and submit to google, yahoo and bing. -####13. It has in-build dynamic sitemap generation. +13. It has in-build dynamic sitemap generation. -####14. Click "Go Live" from "Site Configuration" +14. Click "Go Live" from "Site Configuration" -####15. You site is up and running with SEO compliance. +15. You site is up and running with SEO compliance. -####16. User management, manage different type users. +16. User management, manage different type users. -####17. You can select "Plugin" and add or remove the plugins. There are various plugins available to manage day-to-day employee managment, leave managment, etc. +17. You can select "Plugin" and add or remove the plugins. There are various plugins available to manage day-to-day employee managment, leave managment, etc. -##Contact +## Contact Contact **[support@joshsoftware.com](mailto:support@joshsoftware.com)** for any queries and issues.