Skip to content
This repository has been archived by the owner on Aug 30, 2021. It is now read-only.

Migrated the Website to Jekyll and set-up for 0.4.0 documentation #649

Merged
merged 18 commits into from
Jul 15, 2015

Conversation

codydaig
Copy link
Member

Reference Issues #294 #443

@codydaig
Copy link
Member Author

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.

@codydaig
Copy link
Member Author

You can view how it will render on GitHub Pages here:
http://codydaig.github.io/mean/

@@ -1 +0,0 @@
meanjs.org
Copy link
Member

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?

Copy link
Member Author

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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool

@lirantal
Copy link
Member

I guess it looks ok, but probably need another set of eyes of someone who had commited in the past to gh-pages

@ilanbiala
Copy link
Member

@codydaig what's the difference, functionally, between the Jekyll setup and the current gh-pages branch we have set up?

@codydaig
Copy link
Member Author

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.
As for breaking up the code into sections, I implemented this on the documentation page. So instead of it being around 3.,000 lines of code, it's broken down into 17 pages which is easier to find, add, and modify content. Every section (designated with a link on the sidebar) is it's own .html page but is rendered to the user as one solid page just like it was before.

In terms of user experience, it's identical. It's mostly the managing the content is made simpler.

@ilanbiala
Copy link
Member

@lirantal I think it's a good idea. WDYT?

@lirantal
Copy link
Member

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.

@ilanbiala ilanbiala added this to the 0.4.0 milestone Jul 15, 2015
@ilanbiala
Copy link
Member

@lirantal do we have any 0.4.0 documentation? There are a few issues relating to that.

@codydaig
Copy link
Member Author

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.

@lirantal
Copy link
Member

thanks @codydaig , applied.
@ilanbiala I don't think there's any "proper" 0.4.0 documentation. That branch originally came from Amos a long time ago and made considerable changes there to structure, etc...

lirantal added a commit that referenced this pull request Jul 15, 2015
Migrated the Website to Jekyll and set-up for 0.4.0 documentation
@lirantal lirantal merged commit 6122793 into meanjs:gh-pages Jul 15, 2015
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants