Giter Club home page Giter Club logo

documentation's Introduction

LocomotiveCMS Documentation

Welcome to the documentation for LocomotiveCMS, an open source content management system. You can find this documentation online at http://doc.locomotivecms.com.

If you find errors, would like to add content, or have other contributions, please open a GitHub issue or submit a pull request. All contributions are greatly appreciated.

If you need help using LocomotiveCMS, please don't open an issue here. Instead post in our Google Group. Thanks!

Contributing

This repository is itself a LocomotiveCMS Wagon project. To contribute, first fork the repository. You can then clone it to your machine and make changes as you would to any LocomotiveCMS project and preview your changes with bundle exec wagon serve.

Once you've committed your changes, push them to your fork and send us a pull request.

All contributions are greatly appreciated. Further, we expect that pull requests addressing open issues will be greatly rewarded in the after life. ๐Ÿ™‡

documentation's People

Contributors

aaronrenner avatar alexagui avatar amejiarosario avatar anja98 avatar atsign avatar audionerd avatar benjaminwood avatar bmaland avatar conroywhitney avatar ddeyoung avatar did avatar dirklectisch avatar estellelocomotivecms avatar fabienheureux avatar gabrielnau avatar glebe avatar gravypower avatar hashnotadam avatar jadaw1n avatar jaredklewis avatar jdlich avatar jensdebergh avatar jloosfelt avatar kevgo avatar manuchap avatar mariovisic avatar maxim-filimonov avatar reka avatar youroff avatar yrb avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

documentation's Issues

'bundle exec unicorn_rails' stuck in some kind of loop on OS X 10.11

After following the OS X install guide for wagon and engine, I got all the way up to the bundle exec unicorn_rails command, but end up in some kind of error loop. This sort of thing goes on forever til I kill the process.

Obelus:test_cms josh$ bundle exec unicorn_rails
I, [2015-12-27T15:56:46.186405 #57860]  INFO -- : listening on addr=0.0.0.0:8080 fd=9
I, [2015-12-27T15:56:46.186526 #57860]  INFO -- : worker=0 spawning...
I, [2015-12-27T15:56:46.187314 #57860]  INFO -- : master process ready
I, [2015-12-27T15:56:46.188285 #57861]  INFO -- : worker=0 spawned pid=57861
I, [2015-12-27T15:56:46.188660 #57861]  INFO -- : Refreshing Gem list
/Users/josh/.rvm/gems/ruby-2.2.1/gems/activesupport-3.2.19/lib/active_support/values/time_zone.rb:270: warning: circular argument reference - now
/Users/josh/.rvm/gems/ruby-2.2.1/gems/locomotive_liquid-2.4.2/lib/liquid/htmltags.rb:43: warning: duplicated key at line 46 ignored: "index0"
/Users/josh/.rvm/gems/ruby-2.2.1/gems/fog-1.12.1/lib/fog/aws/compute.rb:200: warning: duplicated key at line 208 ignored: :internet_gateways
Digest::Digest is deprecated; use Digest
/Users/josh/.rvm/gems/ruby-2.2.1/gems/fog-1.12.1/lib/fog/rackspace/mock_data.rb:41: warning: duplicated key at line 79 ignored: "name"
E, [2015-12-27T15:56:48.080369 #57861] ERROR -- : undefined method `secret_key=' for Devise:Module (NoMethodError)
/Users/josh/Downloads/locomotive/test_cms/config/initializers/devise.rb:4:in `block in <top (required)>'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/devise-2.2.7/lib/devise.rb:267:in `setup'
/Users/josh/Downloads/locomotive/test_cms/config/initializers/devise.rb:3:in `<top (required)>'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/activesupport-3.2.19/lib/active_support/dependencies.rb:245:in `load'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/activesupport-3.2.19/lib/active_support/dependencies.rb:245:in `block in load'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/activesupport-3.2.19/lib/active_support/dependencies.rb:236:in `load_dependency'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/activesupport-3.2.19/lib/active_support/dependencies.rb:245:in `load'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/railties-3.2.19/lib/rails/engine.rb:593:in `block (2 levels) in <class:Engine>'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/railties-3.2.19/lib/rails/engine.rb:592:in `each'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/railties-3.2.19/lib/rails/engine.rb:592:in `block in <class:Engine>'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/railties-3.2.19/lib/rails/initializable.rb:30:in `instance_exec'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/railties-3.2.19/lib/rails/initializable.rb:30:in `run'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/railties-3.2.19/lib/rails/initializable.rb:55:in `block in run_initializers'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/railties-3.2.19/lib/rails/initializable.rb:54:in `each'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/railties-3.2.19/lib/rails/initializable.rb:54:in `run_initializers'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/railties-3.2.19/lib/rails/application.rb:136:in `initialize!'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/railties-3.2.19/lib/rails/railtie/configurable.rb:30:in `method_missing'
/Users/josh/Downloads/locomotive/test_cms/config/environment.rb:5:in `<top (required)>'
config.ru:4:in `require'
config.ru:4:in `block in <main>'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/rack-1.4.7/lib/rack/builder.rb:51:in `instance_eval'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/rack-1.4.7/lib/rack/builder.rb:51:in `initialize'
config.ru:1:in `new'
config.ru:1:in `<main>'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/unicorn-5.0.1/lib/unicorn.rb:46:in `eval'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/unicorn-5.0.1/lib/unicorn.rb:46:in `block in builder'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/unicorn-5.0.1/bin/unicorn_rails:139:in `call'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/unicorn-5.0.1/bin/unicorn_rails:139:in `block in rails_builder'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/unicorn-5.0.1/lib/unicorn/http_server.rb:752:in `call'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/unicorn-5.0.1/lib/unicorn/http_server.rb:752:in `build_app!'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/unicorn-5.0.1/lib/unicorn/http_server.rb:617:in `init_worker_process'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/unicorn-5.0.1/lib/unicorn/http_server.rb:639:in `worker_loop'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/unicorn-5.0.1/lib/unicorn/http_server.rb:508:in `spawn_missing_workers'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/unicorn-5.0.1/lib/unicorn/http_server.rb:132:in `start'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/unicorn-5.0.1/bin/unicorn_rails:209:in `<top (required)>'
/Users/josh/.rvm/gems/ruby-2.2.1/bin/unicorn_rails:23:in `load'
/Users/josh/.rvm/gems/ruby-2.2.1/bin/unicorn_rails:23:in `<main>'
/Users/josh/.rvm/gems/ruby-2.2.1/bin/ruby_executable_hooks:15:in `eval'
/Users/josh/.rvm/gems/ruby-2.2.1/bin/ruby_executable_hooks:15:in `<main>'
E, [2015-12-27T15:56:48.088377 #57860] ERROR -- : reaped #<Process::Status: pid 57861 exit 1> worker=0
I, [2015-12-27T15:56:48.088665 #57860]  INFO -- : worker=0 spawning...
I, [2015-12-27T15:56:48.090643 #57862]  INFO -- : worker=0 spawned pid=57862
I, [2015-12-27T15:56:48.091174 #57862]  INFO -- : Refreshing Gem list
/Users/josh/.rvm/gems/ruby-2.2.1/gems/activesupport-3.2.19/lib/active_support/values/time_zone.rb:270: warning: circular argument reference - now
/Users/josh/.rvm/gems/ruby-2.2.1/gems/locomotive_liquid-2.4.2/lib/liquid/htmltags.rb:43: warning: duplicated key at line 46 ignored: "index0"
/Users/josh/.rvm/gems/ruby-2.2.1/gems/fog-1.12.1/lib/fog/aws/compute.rb:200: warning: duplicated key at line 208 ignored: :internet_gateways
Digest::Digest is deprecated; use Digest
/Users/josh/.rvm/gems/ruby-2.2.1/gems/fog-1.12.1/lib/fog/rackspace/mock_data.rb:41: warning: duplicated key at line 79 ignored: "name"
E, [2015-12-27T15:56:50.011134 #57862] ERROR -- : undefined method `secret_key=' for Devise:Module (NoMethodError)
/Users/josh/Downloads/locomotive/test_cms/config/initializers/devise.rb:4:in `block in <top (required)>'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/devise-2.2.7/lib/devise.rb:267:in `setup'
/Users/josh/Downloads/locomotive/test_cms/config/initializers/devise.rb:3:in `<top (required)>'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/activesupport-3.2.19/lib/active_support/dependencies.rb:245:in `load'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/activesupport-3.2.19/lib/active_support/dependencies.rb:245:in `block in load'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/activesupport-3.2.19/lib/active_support/dependencies.rb:236:in `load_dependency'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/activesupport-3.2.19/lib/active_support/dependencies.rb:245:in `load'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/railties-3.2.19/lib/rails/engine.rb:593:in `block (2 levels) in <class:Engine>'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/railties-3.2.19/lib/rails/engine.rb:592:in `each'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/railties-3.2.19/lib/rails/engine.rb:592:in `block in <class:Engine>'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/railties-3.2.19/lib/rails/initializable.rb:30:in `instance_exec'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/railties-3.2.19/lib/rails/initializable.rb:30:in `run'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/railties-3.2.19/lib/rails/initializable.rb:55:in `block in run_initializers'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/railties-3.2.19/lib/rails/initializable.rb:54:in `each'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/railties-3.2.19/lib/rails/initializable.rb:54:in `run_initializers'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/railties-3.2.19/lib/rails/application.rb:136:in `initialize!'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/railties-3.2.19/lib/rails/railtie/configurable.rb:30:in `method_missing'
/Users/josh/Downloads/locomotive/test_cms/config/environment.rb:5:in `<top (required)>'
config.ru:4:in `require'
config.ru:4:in `block in <main>'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/rack-1.4.7/lib/rack/builder.rb:51:in `instance_eval'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/rack-1.4.7/lib/rack/builder.rb:51:in `initialize'
config.ru:1:in `new'
config.ru:1:in `<main>'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/unicorn-5.0.1/lib/unicorn.rb:46:in `eval'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/unicorn-5.0.1/lib/unicorn.rb:46:in `block in builder'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/unicorn-5.0.1/bin/unicorn_rails:139:in `call'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/unicorn-5.0.1/bin/unicorn_rails:139:in `block in rails_builder'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/unicorn-5.0.1/lib/unicorn/http_server.rb:752:in `call'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/unicorn-5.0.1/lib/unicorn/http_server.rb:752:in `build_app!'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/unicorn-5.0.1/lib/unicorn/http_server.rb:617:in `init_worker_process'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/unicorn-5.0.1/lib/unicorn/http_server.rb:639:in `worker_loop'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/unicorn-5.0.1/lib/unicorn/http_server.rb:508:in `spawn_missing_workers'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/unicorn-5.0.1/lib/unicorn/http_server.rb:519:in `maintain_worker_count'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/unicorn-5.0.1/lib/unicorn/http_server.rb:283:in `join'
/Users/josh/.rvm/gems/ruby-2.2.1/gems/unicorn-5.0.1/bin/unicorn_rails:209:in `<top (required)>'
/Users/josh/.rvm/gems/ruby-2.2.1/bin/unicorn_rails:23:in `load'
/Users/josh/.rvm/gems/ruby-2.2.1/bin/unicorn_rails:23:in `<main>'
/Users/josh/.rvm/gems/ruby-2.2.1/bin/ruby_executable_hooks:15:in `eval'
/Users/josh/.rvm/gems/ruby-2.2.1/bin/ruby_executable_hooks:15:in `<main>'
E, [2015-12-27T15:56:50.017956 #57860] ERROR -- : reaped #<Process::Status: pid 57862 exit 1> worker=0
I, [2015-12-27T15:56:50.018098 #57860]  INFO -- : worker=0 spawning...
I, [2015-12-27T15:56:50.019711 #57863]  INFO -- : worker=0 spawned pid=57863
I, [2015-12-27T15:56:50.020107 #57863]  INFO -- : Refreshing Gem list
/Users/josh/.rvm/gems/ruby-2.2.1/gems/activesupport-3.2.19/lib/active_support/values/time_zone.rb:270: warning: circular argument reference - now
^CI, [2015-12-27T15:56:50.588528 #57860]  INFO -- : reaped #<Process::Status: pid 57863 exit 0> worker=0
I, [2015-12-27T15:56:50.588662 #57860]  INFO -- : master complete
Obelus:test_cms josh$ 

Installing the Engine

I'm a Ruby newbie and just spent about an hour trying to get the engine installed and running. Everything worked great, but I ran into 2 issues that might be worth updating on your documentation site

  1. On Step 4. Instead of using this command: "bundle exec rails g locomotive:install" I had to use this command: "rails g locomotive:install"
  2. Once I got the engine running, the css/js files weren't being generated. I finally figured out that I had to add "config.assets.enabled = true" to my development.rb file. One I did that, the css and js files were generated properly.

No documentation on how to pull content entries through the api, or in general how to use locomotive as a service

Often a code base can become a mess when you have a cms, e-commerce platform, and other components jumbled into one app. It's more desirable in this case to keep those platforms separate, and consume then as needed through an API in the public facing application. This keeps the main app thin and flexible.

For those of us who want to use locomotive purely for its content editing, organization, and admin capabilities, and keep it separate from our consuming application, there is no documentation on how to pull content entries through a rest API.

I.E., let's say I want to create a list of classes available at a school in Locomotive. What would be the api call to A) get those list of classes and B) get the content for each class?

There should be some better documentation with examples of consuming Locomotive content from the outside.

An easier solution would be, when creating a content entry in the admin, to display it's publicly accessible url. Same could go for for folders of content entries.

Problem with auto generated content

Following the 'making blog' tutorial at http://doc.locomotivecms.com/making-blog I encountered problem which I can't overcome. After placing http://doc.locomotivecms.com/making-blog/posts.yml inside data/posts.yml and executing bundle exec wagon push development --data I get an error featured_image => can't be blank. This error is caused by the url in the file field. When I put there valid file url (like images/1024x768.png) everything works fine. How to force locomotivecms to accept urls like it is shown in the tutorial?
I get similar error in data/photos.yml for the post: field (same message). In my file there is only one photo entry with post: afternoon-delight (I checked that localhost:8080/posts/afternoon-delight exists). If anyone could help me with this I would be very thankful.
Locomotivecms looks great. For now it looks like the CMS I was looking for.

Missing example files in making a blog tutorial

I noticed two files are missing that are referenced in the tutorial:

  1. The example photos.yml in chapter 3-5
  2. The 'gyeongbokgung-full.jpg' image from chapter 2-3

The second file is in the repo but doesn't seem to link correctly. The missing files didn't stop me from finishing the tutorial but still worth fixing.

Documentation for developing "widgets"

Hi, we're evaluating Locomotive CMS to give our customers the ability to build template-driven websites on our SaaS platform. Our SaaS platform is managing some data for our customers and can probably push the data to Mongo so that it's available to Locomotive CMS as custom-objects.

Now, my question is that we need to show a lot of "widgets" on the template-driven websites. A customer should have the ability to drag/drop widgets into designated areas (pretty much like how it's done in Wordpress). A customer should have the ability to tweak/customize some widget-specific settings.A few examples of widgets:

  • Image slider on home page
  • Twitter feed widget
  • Weather widget
  • Upcoming events (our SaaS platform is for event ticketing)
  • Recently booked events

What's the recommended way to build this out on top of Locomotive CMS? Is there any doc / guide which describes the process?

Devise secret_key missing from documentation.

From here: http://doc.locomotivecms.com/get-started/install-engine-locally#mac

bundle exec unicorn_rails
produces errors, specifically,

"undefined method `secret_key=' for Devise:Module (NoMethodError)"

I commented out the config.secret_key in config/initializers/devise.rb, and the unicorn_rails works now, but this seems like an important step that wasn't mentioned in documentation.

How important is this secret_key, and if it's not that important, does there need to be a "comment this out" step?

documentation for the (for loop)

{% for post in content_type.posts %} should we start using the content_type like in the new documentation or should we continue to use contents.posts

'bundler' gem appears to be a dependency not specified in blog tutorial ?

Apologies as I am new to ruby so this might be evident to someone else. Working through the blog tutorial and I:

  • installed XCode
  • verified that ruby was at 2.0.0 (my default from OSX)
  • installed wagon

After which I ran:

$ wagon init blog . -t bootstrap3

At the end of the installation process I got the error:

 run  bundle install
/System/Library/Frameworks/Ruby.framework/Versions/2.0/usr/lib/ruby/2.0.0/rubygems.rb:269:in `bin_path': can't find gem bundler (>= 0) (Gem::GemNotFoundException)

I "solved" this by running gem install bundler in the working directory; I'm not sure if this is an ideal solution but allowed me to finish the install. Only posting here in case someone who knows more about Ruby gems can indicate whether this was particular to my setup or something that might affect all new mac users (in which case a note in the first section of the tutorial might be nice).

Thanks a tonne either way. LocomotiveCMS looks awesome.

The wizard is not present at localhost:8080

The guide says one should start the server and

open localhost:8080

But there is no wizard there:

Startsidens innholds This is the content for the homepage

The routes mounts locomotive at /locomotive. When visiting /locomotive I'm asked for u/p. Is the doc outdated or have I skipped a step?

screen shot 2014-06-21 at 14 40 08

I've created a github repo from my newly initialized project, please have a look: https://github.com/stabenfeldt/LocomotiveCMS

Make wagon installation clearer for developers

There's a lot of text for beginners on the install wagon page, but really all experienced developers will care about is:

gem install locomotivecms_wagon

So maybe it should be bold. I'd say even mention it on top, replacing this:

Ruby veterans and experienced users may already have some or all of these dependencies installed, so feel free to skim.

With something like:

Ruby veterans and experienced users may already have some or all of these dependencies installed, so you might only need to run gem install locomotivecms_wagon

My initial thought was to run gem install wagon, but then I realized that was an entirely different thing, so then I had to look at your docs and the gem name didn't immediately stand out, which is annoying. ๐Ÿ˜ž

Documentation for page generation is incorrect

Right now it says to generate a page using this command

bundle exec wagon generate your-page-slug

It should read:

bundle exec wagon generate page your-page-slug-or-fullpath

I can fix this later this weekend

decent multisite documentation

no good documentation at the moment, its taking way to long to figure out how multisites work.

Locally how does one add a new site?
editing hostfile to have 127.0.0.1 cms.dev

Please address this lack in documentation, the cms looks promising.

Nokogiri issue?

Hi guys,

I'm working on your 'Getting Started' tutorial, and I am on the part where one runs bundle install after initializing the rails app and editing the Gemfile. When I try to do so, I get the following error:

An error occurred while installing nokogiri (1.5.11), and Bundler cannot continue.
Make sure that `gem install nokogiri -v '1.5.11'` succeeds before bundling.

I try out gem install nokogiri -v '1.5.11' and it works fine, but then I try bundle install/sudo bundle install again and it still returns the same error.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.