Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Already on GitHub? Sign in to your account

Another broken link in index.md #18

Merged
merged 1 commit into from Jan 21, 2012

Conversation

Projects
None yet
3 participants
@jogjayr jogjayr fixed broken link for jekyll quick start on index.md. checked and mad…
…e sure there are no more broken links on that page
5efb722
Contributor

swanson commented Jan 21, 2012

Thanks for the fix, I'm sure @plusjade will merge it in.

If you are looking for other things in this same area to improve on, you could change all of these links to be relative URLs - that way you can build the docs locally and all the links will be properly prefixed with localhost.

Contributor

jogjayr commented Jan 21, 2012

How do you build the docs locally? I tried running

rake -f Rakefile

but it didn't work. I know practically nothing about Ruby

Also, is that the best approach? The way it is right now, I can access the docs online without building them locally. My understanding of your suggestion is to change URLs like http://jekyllbootstrap.com/usage/jekyll-quick-start.html to just usage/jekyll-quick-start.html. If a user doesn't build the docs locally, but runs

jekyll --server

like I did, just to try it out, they would have an index page full of broken links. I may have misunderstood your intention though.

Contributor

swanson commented Jan 21, 2012

Sorry, my wording of 'build the docs' is slightly misleading

If you checkout the gh-pages branch of the project (git checkout gh-pages) and run jekyll --server you will be serving the documentation site. Any changes to the documentation of http://jekyllbootstrap.com/ should be done in that branch - any of the pages in the master branch will eventually be removed by the user when they create their own blog.

You will notice that if you look at the gh-pages branch, index.md has the correct URL already and already seems to be using relative URLs.

I missed this fact when I suggested that you use relative URLs - in fact, you are correct that the master branch version should probably link directly to the official site. My apologies for leading you down a dead-end, but make sure if you are looking to fix documentation-related issues in the future that you are working in the gh-pages branch.

Owner

plusjade commented Jan 21, 2012

Thanks @jogjayr, I imagine I have a lot of other small typos and grammar errors littered throughout ;) Seems a good number of pull requests are typos! This definitely is important though, so keep up the good work.

@plusjade plusjade added a commit that referenced this pull request Jan 21, 2012

@plusjade plusjade Merge pull request #18 from jogjayr/master
Another broken link in index.md
b7a353c

@plusjade plusjade merged commit b7a353c into plusjade:master Jan 21, 2012

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment