-
Notifications
You must be signed in to change notification settings - Fork 2k
Migrated the Website to Jekyll and set-up for 0.4.0 documentation #649
Conversation
Merge Gh pages jekyll Branch
I didn't change the content of the website, just migrated it into a modular format around jekyll and set-up the folder structure for the docs for 0.4.0. I'm completely open for feedback if a different structure or method is desired. This was just the quickest way to get it up and running to match it's current state and easily add new documentation in a modular form. |
You can view how it will render on GitHub Pages here: |
@@ -1 +0,0 @@ | |||
meanjs.org |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why is the CNAME entry removed?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I made that change after I submitted the pull request to make it render on my GitHub Pages for demonstration. I forgot that it would have added it too the pull request. My apologies. Once it's approved too be merged let me know and I'll change it back.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Cool
I guess it looks ok, but probably need another set of eyes of someone who had commited in the past to gh-pages |
@codydaig what's the difference, functionally, between the Jekyll setup and the current gh-pages branch we have set up? |
The main difference is the ability to use templates which allows areas such as the documentation to be broken up into sections. Makes the code cleaner and easier to maintain. The current website has the same header and footer elements copied into each individual html page, so if you need to make one change, you have to change every page. With jekyll, you just change it once in the template and it's changed on all pages. In terms of user experience, it's identical. It's mostly the managing the content is made simpler. |
@lirantal I think it's a good idea. WDYT? |
Sure, @codydaig can you please have another walk-through on the rendered page, some general sanity to see that nothing is broken and I'll be happy to merge. |
@lirantal do we have any 0.4.0 documentation? There are a few issues relating to that. |
I added the CNAME back in as well as put the relative links back to work from the root directory. (So the demo at codydaig.github.io/mean is broken but will work on gh-pages for meanjs.org) I went through and tested this thoroughly on my local machine by modifying my local hosts file. I also removed the sample page, post, and sass files that Jekyll comes with by default. This commit is good to go and ready to be merged. |
thanks @codydaig , applied. |
Migrated the Website to Jekyll and set-up for 0.4.0 documentation
Reference Issues #294 #443