adamcooke / documentation Goto Github PK

View Code? Open in Web Editor NEW

215.0 215.0 39.0 185 KB

A Rails engine to provide the ability to add documentation to a Rails application

License: MIT License

Ruby 78.59% JavaScript 2.28% CSS 2.35% HTML 16.78%

documentation's People

Contributors

Stargazers

Watchers

documentation's Issues

Invalid links to pages

Hi,

I have installed documentation gem to Rails 4.2.0.beta2 project (as described in Installation section of README). But it builds incorrect links to pages (see attachment) i.e. without /docs.

Thanks

when mounting as root, navigation fails

When mounting at "/" instead of "/docs", the left hand navigation elements fail to include the domain reference: http://grab.by/yONq

rake task exception when running initial import

When trying to run the "documentation:install_guides" rake task on Rails 4.2.1 (using Postgres), I get the error:

rake aborted!
ActiveRecord::StatementInvalid: PG::InvalidTextRepresentation: ERROR: invalid input syntax for integer: "authorization"
: SELECT 1 AS one FROM "documentation_pages" WHERE "documentation_pages"."parent_id" = $1 AND "documentation_pages"."parent_id" = $2 AND "documentation_pages"."permalink" = $3 LIMIT 1

License?

Awesome project, looks really useful. I noticed the gemspec says it's under MIT license, but it's not mentioned anywhere in the readme or contained in a license file in the repo. Is the project officially MIT licensed?

Link to screenshot in README broken

Screenshot link in README.md is broken.

Latest released version (1.0.9) not compatible with Rails 5.2.2

According to https://rubygems.org/gems/documentation the latest released version is 1.0.9 which does not include the fix on rails version boundary check (656d021).
Could you release a new version?

Fetching gem metadata from https://rubygems.org/............
Fetching gem metadata from https://rubygems.org/.
Resolving dependencies...
Bundler could not find compatible versions for gem "rails":
  In snapshot (Gemfile.lock):
    rails (= 5.2.2)

  In Gemfile:
    rails (~> 5.2.2)

    documentation (~> 1.0.9) was resolved to 1.0.9, which depends on
      rails (< 5.0, >= 4.0.0)

Running `bundle update` will rebuild your snapshot from scratch, using only
the gems in your Gemfile, which may resolve the conflict.

Deploy on viaduct failed

https://gist.github.com/brianjking/8360b80172108869579b

Help? Thanks!

Rails 4.2 compatibility

Hi,

Could you please fix compatibility with Rails 4.2.beta2 (it depends to jquery-rails (4.0.0.beta2)):

Bundler could not find compatible versions for gem "jquery-rails":
  In Gemfile:
    documentation (~> 1.0.5) ruby depends on
      jquery-rails (~> 3) ruby

    jquery-rails (4.0.0.beta2)

Thanks

Uninstall Instructions? ... db:rollback isn't working

Could you include uninstall instructions as well? This modified my DB and a rollback doesn't seem to undo (I'm guessing it's because engines behave as separate apps? ... dunno).

ArgumentError after initial install

ArgumentError at /positioning - wrong number of arguments (0 for 1): http://grab.by/yx8G

and same for creating a new root page: http://grab.by/yx8Q

(Optionally) replace pygments.rb with rouge

It would be great to have the option to use rouge instead of pygments.rb. While rouge supports fewer languages, pygments.rb is problematic in a Windows or JRuby environment because it requires posix-spawn C extensions and a separate Python/pygments install.

Help launching on Amazon EC2 Micro instance (Ubuntu)

Hello,

I have a Amazon EC2 Micro Instance using ServerPilot (http://serverpilot.com) and am having trouble getting this loaded.

Can you please help?

Thanks!

question: how does a user switch between being a doc admin and a doc viewer?

It appears that by default when you navigate to /docs you're able to manage doc content. How does a user login / authorize themself as a doc admin (and by default, hide the buttons to edit)?

bundle exec rake db:migrate documentation:install_guides crashes with undefined method `parameterize'

Command executed

bundle exec rails generate documentation:setup
bundle exec rake db:migrate documentation:install_guides --trace

Versions

Rails 4.0.0
Rake 10.3.2
bundle 1.6.1

Traceback

MacBook-Pro:face_rec_server idyllicsoftwarepvtltd$ bundle exec rake db:migrate documentation:install_guides --trace
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1@global/gems/bundler-1.6.1/lib/bundler/runtime.rb:222: warning: Insecure world writable dir /usr/local/bin in PATH, mode 040777
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1@global/gems/bundler-1.6.1/lib/bundler.rb:301: warning: Insecure world writable dir /usr/local/bin in PATH, mode 040777
** Invoke db:migrate (first_time)
** Invoke environment (first_time)
** Execute environment
** Invoke db:load_config (first_time)
** Execute db:load_config
** Execute db:migrate
** Invoke db:_dump (first_time)
** Execute db:_dump
** Invoke db:schema:dump (first_time)
** Invoke environment 
** Invoke db:load_config 
** Execute db:schema:dump
** Invoke documentation:install_guides (first_time)
** Invoke environment 
** Execute documentation:install_guides
rake aborted!
NoMethodError: undefined method `parameterize' for nil:NilClass
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/gems/documentation-1.0.5/app/models/documentation/page.rb:39:in `set_permalink'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/gems/activesupport-4.0.0/lib/active_support/callbacks.rb:387:in `_run__1814141649975223354__validation__callbacks'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/gems/activesupport-4.0.0/lib/active_support/callbacks.rb:80:in `run_callbacks'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/gems/activemodel-4.0.0/lib/active_model/validations/callbacks.rb:106:in `run_validations!'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/gems/activemodel-4.0.0/lib/active_model/validations.rb:314:in `valid?'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/gems/activerecord-4.0.0/lib/active_record/validations.rb:70:in `valid?'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/gems/activerecord-4.0.0/lib/active_record/validations.rb:77:in `perform_validations'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/gems/activerecord-4.0.0/lib/active_record/validations.rb:51:in `save'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/gems/activerecord-4.0.0/lib/active_record/attribute_methods/dirty.rb:32:in `save'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/gems/activerecord-4.0.0/lib/active_record/transactions.rb:270:in `block (2 levels) in save'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/gems/activerecord-4.0.0/lib/active_record/transactions.rb:326:in `block in with_transaction_returning_status'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/gems/activerecord-4.0.0/lib/active_record/connection_adapters/abstract/database_statements.rb:202:in `block in transaction'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/gems/activerecord-4.0.0/lib/active_record/connection_adapters/abstract/database_statements.rb:210:in `within_new_transaction'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/gems/activerecord-4.0.0/lib/active_record/connection_adapters/abstract/database_statements.rb:202:in `transaction'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/gems/activerecord-4.0.0/lib/active_record/transactions.rb:209:in `transaction'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/gems/activerecord-4.0.0/lib/active_record/transactions.rb:323:in `with_transaction_returning_status'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/gems/activerecord-4.0.0/lib/active_record/transactions.rb:270:in `block in save'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/gems/activerecord-4.0.0/lib/active_record/transactions.rb:281:in `rollback_active_record_state!'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/gems/activerecord-4.0.0/lib/active_record/transactions.rb:269:in `save'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/gems/protected_attributes-1.0.3/lib/active_record/mass_assignment_security/persistence.rb:46:in `create'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/gems/documentation-1.0.5/db/seeds.rb:7:in `<top (required)>'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/gems/activesupport-4.0.0/lib/active_support/dependencies.rb:228:in `require'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/gems/activesupport-4.0.0/lib/active_support/dependencies.rb:228:in `block in require'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/gems/activesupport-4.0.0/lib/active_support/dependencies.rb:213:in `load_dependency'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/gems/activesupport-4.0.0/lib/active_support/dependencies.rb:228:in `require'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/gems/documentation-1.0.5/lib/tasks/documentation.rake:4:in `block (2 levels) in <top (required)>'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/gems/rake-10.3.2/lib/rake/task.rb:240:in `call'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/gems/rake-10.3.2/lib/rake/task.rb:240:in `block in execute'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/gems/rake-10.3.2/lib/rake/task.rb:235:in `each'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/gems/rake-10.3.2/lib/rake/task.rb:235:in `execute'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/gems/rake-10.3.2/lib/rake/task.rb:179:in `block in invoke_with_call_chain'
/Users/idyllicsoftwarepvtltd/.rvm/rubies/ruby-2.1.1/lib/ruby/2.1.0/monitor.rb:211:in `mon_synchronize'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/gems/rake-10.3.2/lib/rake/task.rb:172:in `invoke_with_call_chain'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/gems/rake-10.3.2/lib/rake/task.rb:165:in `invoke'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/gems/rake-10.3.2/lib/rake/application.rb:150:in `invoke_task'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/gems/rake-10.3.2/lib/rake/application.rb:106:in `block (2 levels) in top_level'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/gems/rake-10.3.2/lib/rake/application.rb:106:in `each'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/gems/rake-10.3.2/lib/rake/application.rb:106:in `block in top_level'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/gems/rake-10.3.2/lib/rake/application.rb:115:in `run_with_threads'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/gems/rake-10.3.2/lib/rake/application.rb:100:in `top_level'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/gems/rake-10.3.2/lib/rake/application.rb:78:in `block in run'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/gems/rake-10.3.2/lib/rake/application.rb:176:in `standard_exception_handling'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/gems/rake-10.3.2/lib/rake/application.rb:75:in `run'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/gems/rake-10.3.2/bin/rake:33:in `<top (required)>'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/bin/rake:23:in `load'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/bin/rake:23:in `<main>'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/bin/ruby_executable_hooks:15:in `eval'
/Users/idyllicsoftwarepvtltd/.rvm/gems/ruby-2.1.1/bin/ruby_executable_hooks:15:in `<main>'
Tasks: TOP => documentation:install_guides

Releases not tagged as git tags

I see that releases are not tagged in git (hub). I propose to use the bundle gem (https://bundler.io/man/bundle-gem.1.html) stack, which would allow for a rake release task doing all the goodies for you, including pushes to rubygems and github.

Version that works with Rails 3.2

For anyone looking for a rails 3.2 version of this gem, we've created a fork available at https://github.com/oceanshq/documentation

issue with screenshot attachments

After running the installation then migrations, when i try to upload a screenshot, the following error occurs: http://paste.codebasehq.com/pastes/xgscd9sa0zredy6k51

DEPRECATION WARNING: ActionView::Template::Handlers::Erubis is deprecated and will be removed from Rails 5.2. Switch to ActionView::Template::Handlers::ERB::Erubi instead.

Gem giving a deprecation warning with rails version 5.1.4

DEPRECATION WARNING: ActionView::Template::Handlers::Erubis is deprecated and will be removed from Rails 5.2. Switch to ActionView::Template::Handlers::ERB::Erubi instead. (called from <top (required)> at /home/username/.rvm/gems/ruby-2.3.3/bundler/gems/documentation-380bffcad47a/lib/documentation.rb:1)

Rails version - 5.1.4
Ruby version - 2.3.3
Documentation version - (1.0.10)

Internal project documentation

Hi,

Is it possible to setup things in such a way to use it for internal project documentation ?

My understanding is that pages are stored in the database, but what if the db is erased for dev purposes for example ?

Recommend Projects

React

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

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

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

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
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.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

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

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.