New issue

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

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use pages for documentation, not posts, fixes #980. #985

Merged
merged 1 commit into from May 10, 2013

Conversation

Projects
None yet
4 participants
@benbalter
Contributor

benbalter commented Apr 18, 2013

This Pull Request places all the docs in a docs/ folder and removes the post date string from the filename. There should be no visible changes to the resulting site.

We could optionally move them to the root of the site/ folder, or, I believe, move them to /docs/ (root of the repo), and symlink into site/.

@mattr-

This comment has been minimized.

Member

mattr- commented Apr 18, 2013

👍 :shipit:

@parkr

This comment has been minimized.

Member

parkr commented Apr 18, 2013

Wny did you have to add permalinks? I'd put them in index.markdown files in the directories cited.

@benbalter

This comment has been minimized.

Contributor

benbalter commented Apr 18, 2013

Mostly personal preference?

foo/index.html resolving to /foo/ makes sense for people who grew up on Apache, but its purpose may not be so clear for non-developers who we'd want to encourage to contribute to documentation. Looking to edit /docs/configuration by going into a folder called docs then clicking the file named configuration is more intuitive than having to traverse another folder level and find a weird file called "index" even though there's only one file in there.

Not to mention, why should I, as a user, have to create a folder and a file (two operations), when the software can absorb that complexity for me with one?

Unless I missed your question?

parkr added a commit that referenced this pull request May 10, 2013

@parkr parkr merged commit e1f0496 into jekyll:master May 10, 2013

1 check passed

default The Travis build passed
Details

parkr added a commit that referenced this pull request May 10, 2013

@benbalter benbalter deleted the benbalter:docs-pages branch May 10, 2013

@jekyll jekyll locked and limited conversation to collaborators Feb 27, 2017

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