-
Notifications
You must be signed in to change notification settings - Fork 2k
Overview, Troubleshooting, and Permalinks #652
Conversation
@codydaig is there a way I can visually see the changes that this PR adds? |
http://codydaig.github.io/mean/ DO NOT MERGE THIS PULL REQUEST UNTIL I ADD THE CNAME BACK AND MODIFY CONFIG.YML. gh-pages makes it difficult to test on live sites other than the one you want it published too. If you want to test locally, you have to install jekyll and run jekyll serve from the directory. (I put the install and run commands in the README.md file of the gh-pages branch). So, for these bigger changes, I'll just keep it live on my gh-pages branch until it's ready to be merged. |
@ilanbiala @lirantal Thoughts on this structure to differentiate 0.4.x from 0.3.x before I continue adding documentation? |
LGTM |
I think it's fine. |
baseurl: "" # For the Live MEAN WEBSITE | ||
url: "http://meanjs.org/" # FOR THE LIVE MEAN WEBSITE | ||
baseurl: "/mean" # FOR TESTING ONLY | ||
url: "http://codydaig.github.io/" # FOR TESTING ONLY |
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.
Should this be here?
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.
@codydaig did you forget to delete lines 7 and 8?
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.
That is for testing so you can view it on my github pages site.
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.
what's the issue there? @codydaig
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.
@lirantal ??
Also, should the _CNAME be changed back to CNAME? |
@ilanbiala - The _CNAME will be changed back before the pull request is ready. That is for testing so you can view it on my github pages site. |
if we fixed the newline stuff and nothing to add then I'm ok with merging. |
Newline changes have been made and commits have been squashed. |
@ilanbiala I made the new line changes and squashed my commits. Anything else or can this be merged for other people to start contributing? |
Overview, Troubleshooting, and Permalinks
In terms of sections of the documentation, Overview and Troubleshooting were the only two that I could tell didn't need any changes to make then applicable to 0.4.0. The remaining sections have some sort of change to make them applicable.
The navbar has been modified to show the link to 0.4.0 when you hover over it. I also changed the doc folder/file structure slightly to allow for permalinks. /docs.html will go to the current (stable) version which is marked 0.3.x in the code.
Lastly, I added permalinks for:
/docs/0.4.x/ which will render the docs for 0.4.x
/docs/0.3.x/ which will render the docs for 0.3.x (which is the current view)
I did this to allow for multiple versions of the docs on the website as the project continues to develop.
This pull request is ready to be merged, however, I am submitting it as a discussion point for the Yo Generator Section and merging this can be delayed. (Which I am bringing up in #443 )