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

Add project vision to Readme #1935

Merged
merged 4 commits into from Jan 21, 2014

Conversation

Projects
None yet
5 participants
@benbalter
Contributor

benbalter commented Jan 12, 2014

This is a rough first pass at memorializing some of the project vision discussed in #1929.

Often times, as projects grow and gain popularity, it's helpful to have a short description of the project's vision and design philosophy to serve as a lense through which to evaluate proposed features and approaches.

I also tried to update the project description a bit, to better reflect how its often being used today. FWIW, it looks like the blurb hasn't been updated in five years

What I was trying to reflect:

  • “Jekyll is a simple, blog aware, static site generator.”
  • Blog aware, not blog centric
  • File-system based CMS
  • Originally called “autoblog”
  • Despite start, big use case today is technical documentation
  • Not Rails style conventions over configurations
  • Don’t try to outsmart the users
  • Jekyll should do what I tell it to do, no more, no less
  • The three-little bears of CMSs
  • Git should not be a requirement to using Jekyll
  • Marketing for open source projects, people, organizations
  • Make it easier to install (Installer Packages with Ruby/RubyGems & gem dependencies installed)

Again, a very rough first pass, but thought it was at least worth getting the conversation started if there was interest in writing down some of the unsaid assumptions that surround the project's ethos.

@parkr

This comment has been minimized.

Member

parkr commented Jan 12, 2014

@benbalter I dig it, but I both was at the meeting yesterday and maintain the project, so I'm very familiar with its goals already. Would you mind spreading this around to folks who aren't as familiar with the product? I'll tweet from jekyllrb, too, for input. Thanks so much for putting this together! ❤️

@redhotvengeance

This comment has been minimized.

redhotvengeance commented Jan 12, 2014

@benbalter @parkr If one would like to contribute thoughts/suggestion as to wording, typos, etc, should one comment here, or open a pull request on vision @ benbalter/jekyll?

@benbalter

This comment has been minimized.

Contributor

benbalter commented Jan 12, 2014

@redhotvengeance I'd probably suggest making comments or line-comments here so that they have more visibility as I'd imagine more stakeholders would follow the issue here, then follow my fork.

If, e.g., you make a line comment and say teh should be the or it can be better worded as X, I can always update the fork, and it will be reflected in the pull request + noted in the issue.

Again, very much a rough, first pass to start the conversation, so thoughts/suggestions very much encouraged.

@redhotvengeance

This comment has been minimized.

redhotvengeance commented Jan 12, 2014

@benbalter Sounds good - I'll add some line comments on anything that sticks out to me.

@redhotvengeance

This comment has been minimized.

redhotvengeance commented Jan 13, 2014

@benbalter I should add that I dig the new vision paragraphs - forgot to say that before throwing suggestions out there. I just enjoy playing with words, so I was enthused to contribute.

@benbalter

This comment has been minimized.

Contributor

benbalter commented Jan 18, 2014

@redhotvengeance great suggestions all around, and merged in almost word-for-word via e42c1aa.

One note, I added organizations to the list of potential sites to cover things like http://netflix.github.io/.

@redhotvengeance

This comment has been minimized.

redhotvengeance commented Jan 19, 2014

@benbalter Glad to help! I like how you smoothed out the Markdown/Liquid rendering syntax. The org stuff is a nice addition, too.

@mattr-

This comment has been minimized.

Member

mattr- commented Jan 20, 2014

A big 👍 from me. Big ❤️ to @benbalter for updating this.

@parkr

View changes

README.markdown Outdated
@@ -9,7 +9,11 @@
By Tom Preston-Werner, Nick Quaranto, and many [awesome contributors](https://github.com/jekyll/jekyll/graphs/contributors)!
Jekyll is a simple, blog aware, static site generator. It takes a template directory (representing the raw form of a website), runs it through Textile or Markdown and Liquid converters, and spits out a complete, static website suitable for serving with Apache or your favorite web server. This is also the engine behind [GitHub Pages](http://pages.github.com), which you can use to host your project's page or blog right here from GitHub.
Jekyll is a simple, blog-aware, static site generator perfect for personal, project, or organization sites. Think of it like a file-based CMS, sans all the complexity. Jekyll takes your content, renders Markdown and Liquid templates, and spits out a complete, static website ready to be served with Apache, Nginx or your favorite web server. Jekyll is the engine behind [GitHub Pages](http://pages.github.com), which you can use to host sites right from your GitHub repositories.

This comment has been minimized.

@parkr

parkr Jan 20, 2014

Member

This is awesome. What do you think about without instead of sans (thinking about users who don't speak French and who aren't familiar with the English use of the term)? And what do you think about ready to be served by Apache, Nginx, or another web server.?

@parkr

This comment has been minimized.

Member

parkr commented Jan 20, 2014

2 thoughts above then REH-DEE 2 MURDJE!

@benbalter

This comment has been minimized.

Contributor

benbalter commented Jan 21, 2014

2 thoughts above then REH-DEE 2 MURDJE!

Done via e225840.

mattr- added a commit that referenced this pull request Jan 21, 2014

@mattr- mattr- merged commit 5f26bb5 into jekyll:master Jan 21, 2014

1 check passed

default The Travis CI build passed
Details

mattr- added a commit that referenced this pull request Jan 21, 2014

@benbalter benbalter deleted the benbalter:vision branch Jan 21, 2014

@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.