search

imathis / octopress

Octopress is an obsessively designed framework for Jekyll blogging. It’s easy to configure and easy to deploy. Sweet huh?
http://github.com/imathis/octopress
9.32k stars 2.62k forks source link

Separation of configuration file #1630

Open yous opened 10 years ago

yous commented 10 years ago

From an issue of octopress theme https://github.com/lucaslew/whitespace/pull/53#issuecomment-51991825, I realized octopress-date-format gem looks up _octopress.yml as specified at https://github.com/octopress/date-format#configuration.

Is there any special reason for separating a configuration file from _config.yml? Octopress uses octopress-date-format gem from https://github.com/imathis/octopress/commit/73e540409ceb8bc18048b6a96a4b815fc303ea28. Every octopress site's date_format in _config.yml doesn't work immediately when they update octopress.

imathis commented 10 years ago

Many of the new Octopress tools will be splitting the configuration and reading from _octopress.yml instead. It allows me to add configurations that won't conflict with the configurations of other plugins or with features added to Jekyll. By continuing to use the _config.yml, I'd have to namespace everything which is more of a pain. Also this will make it easier for people to know which features are built into Jekyll and which are from elsewhere.

yous commented 10 years ago

I agree with your direction. But we're bit confusing because octopress changes its behavior but we can't find public announcements or release notes. We have to see all commits to find which is causing an issue.

imathis commented 10 years ago

You're right I need to do a better job of communicating that change.

yous commented 10 years ago

I think it would be good if octopress uses Semantic Versioning and make tags for each releases. Maybe we need CHANGELOG.md for making easy to create release notes. Making sure that CHANGELOG.md has every feature changes and bug fixes for each commit (or pull requests) would be a way. Some libraries have their CONTRIBUTING.md which mentions CHANGELOG.md format. Then only have to do is make people to follow CONTRIBUTING.md. I think octopress 3.0 will be a good starting point.

imathis commented 10 years ago

Yes that's the plan actually. The distribution mechanism for this version of Octopress makes it a poor candidate for semantic versioning. Right now I'm focusing most of my attention on 3.0 and just trying to maintain 2.x until I can get this out.

yous commented 10 years ago

I :+1: on it! Hope you to release it soon.