Merge branch 'ticket/master/211-app-docs' into upstream-master
This commit is contained in:
Eric Davis
commit
d9c25d09f3
|
|
@ -19,3 +19,4 @@
|
|||
/tmp/test/*
|
||||
/vendor/rails
|
||||
*.rbc
|
||||
doc/app
|
||||
|
|
|
|||
31
README.rdoc
31
README.rdoc
|
|
@ -1,5 +1,30 @@
|
|||
= Redmine
|
||||
= ChiliProject
|
||||
|
||||
Redmine is a flexible project management web application written using Ruby on Rails framework.
|
||||
ChiliProject is a web based project management system. It supports your team throughout the complete project life cycle, from setting up and discussing a project plan, over tracking issues and reporting work progress to collaboratively sharing knowledge.
|
||||
|
||||
More details can be found at in the doc directory or on the official website http://www.redmine.org
|
||||
More documentation and user guides can be found on the official website[https://www.chiliproject.org] and in the doc/ directory.
|
||||
|
||||
== Getting Started
|
||||
|
||||
We have a complete {install guide}[https://www.chiliproject.org/projects/chiliproject/wiki/Installation] online.
|
||||
|
||||
== Getting Help
|
||||
|
||||
ChiliProject is an run by a community of volunteers. We have set up different ways to get help depending on your preferences.
|
||||
|
||||
* Self guided help and user documentation - https://www.chiliproject.org/projects/chiliproject/wiki/Help
|
||||
* Forums for specific questions - https://www.chiliproject.org/projects/chiliproject/boards
|
||||
* Real time chat using IRC - https://www.chiliproject.org/projects/chiliproject/wiki/IRC
|
||||
* Commercial support - https://www.chiliproject.org/projects/chiliproject/wiki/Commercial_Offerings
|
||||
|
||||
== Contributing
|
||||
|
||||
We welcome all help for the project, no task is too small. Our documentation is editable by anyone on our wiki[https://www.chiliproject.org/projects/chiliproject/wiki], we accept patches on our {issue tracker}[https://www.chiliproject.org/projects/chiliproject/issues], and everyone is welcome to discuss the project in our forums[https://www.chiliproject.org/projects/chiliproject/boards].
|
||||
|
||||
More details can be found on our Contribute page[https://www.chiliproject.org/projects/chiliproject/wiki/Contribute].
|
||||
|
||||
== License
|
||||
|
||||
ChiliProject is licensed under the GNU GPL v2. See the doc directory for more details.
|
||||
|
||||
ChiliProject is a fork based on Redmine. Redmine is Copyright Jean-Philippe Lang and others.
|
||||
|
|
|
|||
|
|
@ -1,8 +1,6 @@
|
|||
== Redmine changelog
|
||||
= ChiliProject changelog
|
||||
|
||||
Redmine - project management software
|
||||
Copyright (C) 2006-2011 Jean-Philippe Lang
|
||||
http://www.redmine.org/
|
||||
Note: Previous versions referred to Redmine, which ChiliProject forked from in December 2010.
|
||||
|
||||
== 2011-01-30 v1.1.1
|
||||
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
ChiliProject is a project management system.
|
||||
|
||||
Copyright (C) 2010 the ChiliProject Team
|
||||
|
||||
This program is free software; you can redistribute it and/or
|
||||
modify it under the terms of the GNU General Public License
|
||||
as published by the Free Software Foundation; either version 2
|
||||
of the License, or (at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program; if not, write to the Free Software
|
||||
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
||||
97
doc/INSTALL
97
doc/INSTALL
|
|
@ -1,97 +0,0 @@
|
|||
== Redmine installation
|
||||
|
||||
Redmine - project management software
|
||||
Copyright (C) 2006-2010 Jean-Philippe Lang
|
||||
http://www.redmine.org/
|
||||
|
||||
|
||||
== Requirements
|
||||
|
||||
* Ruby 1.8.6 or 1.8.7
|
||||
|
||||
* RubyGems 1.3.1
|
||||
|
||||
* Ruby on Rails 2.3.5 (official downloadable Redmine releases are packaged with
|
||||
the appropriate Rails version)
|
||||
|
||||
* Rack 1.0.1 gem
|
||||
|
||||
* Rake 0.8.3 gem
|
||||
|
||||
* I18n 0.4.2 gem
|
||||
|
||||
* A database:
|
||||
* MySQL (tested with MySQL 5)
|
||||
* PostgreSQL (tested with PostgreSQL 8.1)
|
||||
* SQLite (tested with SQLite 3)
|
||||
|
||||
Optional:
|
||||
* SCM binaries (e.g. svn), for repository browsing (must be available in PATH)
|
||||
* RMagick (to enable Gantt export to png images)
|
||||
* Ruby OpenID Library >= version 2 (to enable OpenID support)
|
||||
|
||||
== Installation
|
||||
|
||||
1. Uncompress the program archive
|
||||
|
||||
2. Create an empty database: "redmine" for example
|
||||
|
||||
3. Configure the database parameters in config/database.yml
|
||||
for the "production" environment (default database is MySQL)
|
||||
|
||||
4. Generate a session store secret
|
||||
|
||||
Redmine stores session data in cookies by default, which requires
|
||||
a secret to be generated. Under the application main directory run:
|
||||
rake generate_session_store
|
||||
|
||||
5. Create the database structure
|
||||
|
||||
Under the application main directory run:
|
||||
rake db:migrate RAILS_ENV="production"
|
||||
|
||||
It will create all the tables and an administrator account.
|
||||
|
||||
6. Setting up permissions (Windows users have to skip this section)
|
||||
|
||||
The user who runs Redmine must have write permission on the following
|
||||
subdirectories: files, log, tmp & public/plugin_assets (create the last
|
||||
two if they are not yet present).
|
||||
|
||||
Assuming you run Redmine with a user named "redmine":
|
||||
mkdir tmp public/plugin_assets
|
||||
sudo chown -R redmine:redmine files log tmp public/plugin_assets
|
||||
sudo chmod -R 755 files log tmp public/plugin_assets
|
||||
|
||||
7. Test the installation by running the WEBrick web server
|
||||
|
||||
Under the main application directory run:
|
||||
ruby script/server -e production
|
||||
|
||||
Once WEBrick has started, point your browser to http://localhost:3000/
|
||||
You should now see the application welcome page.
|
||||
|
||||
8. Use the default administrator account to log in:
|
||||
login: admin
|
||||
password: admin
|
||||
|
||||
Go to "Administration" to load the default configuration data (roles,
|
||||
trackers, statuses, workflow) and to adjust the application settings
|
||||
|
||||
== SMTP server Configuration
|
||||
|
||||
Copy config/configuration.yml.example to config/configuration.yml and
|
||||
edit this file to adjust your SMTP settings.
|
||||
Do not forget to restart the application after any change to this file.
|
||||
|
||||
Please do not enter your SMTP settings in environment.rb.
|
||||
|
||||
== References
|
||||
|
||||
* http://www.redmine.org/wiki/redmine/RedmineInstall
|
||||
* http://www.redmine.org/wiki/redmine/EmailConfiguration
|
||||
* http://www.redmine.org/wiki/redmine/RedmineSettings
|
||||
* http://www.redmine.org/wiki/redmine/RedmineRepositories
|
||||
* http://www.redmine.org/wiki/redmine/RedmineReceivingEmails
|
||||
* http://www.redmine.org/wiki/redmine/RedmineReminderEmails
|
||||
* http://www.redmine.org/wiki/redmine/RedmineLDAP
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
= Install
|
||||
|
||||
The detailed installation instructions are located on the {official website}[https://www.chiliproject.org/projects/chiliproject/wiki/Installation]
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
= Redmine
|
||||
|
||||
Redmine is a flexible project management web application written using Ruby on Rails framework.
|
||||
|
||||
More details can be found at http://www.redmine.org
|
||||
|
|
@ -1,11 +1,9 @@
|
|||
Installing gems for testing
|
||||
===========================
|
||||
= Installing gems for testing
|
||||
|
||||
Run `rake gems RAILS_ENV=test` to list the required gems. Run
|
||||
`rake gems:install RAILS_ENV=test` to install any missing gems.
|
||||
|
||||
Running Tests
|
||||
=============
|
||||
== Running Tests
|
||||
|
||||
Run `rake --tasks test` to see available tests.
|
||||
`rake test` will run the entire testsuite.
|
||||
|
|
@ -13,20 +11,18 @@ Run `rake --tasks test` to see available tests.
|
|||
Before running `rake test` you need to configure both development
|
||||
and test databases.
|
||||
|
||||
Creating test repositories
|
||||
===================
|
||||
== Creating test repositories
|
||||
|
||||
Redmine supports a wide array of different version control systems.
|
||||
ChiliProject supports a wide array of different version control systems.
|
||||
To test the support, a test repository needs to be created for each of those.
|
||||
|
||||
Run `rake --tasks test:scm:setup` for a list of available test-repositories or
|
||||
run `rake test:scm:setup:all` to set up all of them
|
||||
|
||||
Creating a test ldap database
|
||||
=============================
|
||||
== Creating a test ldap database
|
||||
|
||||
Redmine supports using LDAP for user authentications. To test LDAP
|
||||
with Redmine, load the LDAP export from test/fixtures/ldap/test-ldap.ldif
|
||||
ChiliProject supports using LDAP for user authentications. To test LDAP
|
||||
with ChiliProject, load the LDAP export from test/fixtures/ldap/test-ldap.ldif
|
||||
into a testing LDAP server. Test that the ldap server can be accessed
|
||||
at 127.0.0.1 on port 389.
|
||||
|
||||
|
|
@ -1,63 +0,0 @@
|
|||
== Redmine upgrade
|
||||
|
||||
Redmine - project management software
|
||||
Copyright (C) 2006-2010 Jean-Philippe Lang
|
||||
http://www.redmine.org/
|
||||
|
||||
|
||||
== Upgrading
|
||||
|
||||
1. Uncompress the program archive in a new directory
|
||||
|
||||
2. Copy your database settings (RAILS_ROOT/config/database.yml)
|
||||
and your configuration file (RAILS_ROOT/config/configuration.yml)
|
||||
into the new config directory
|
||||
Note: before Redmine 1.2, SMTP configuration was stored in
|
||||
config/email.yml. It should now be stored in config/configuration.yml.
|
||||
|
||||
3. Copy the RAILS_ROOT/files directory content into your new installation
|
||||
This directory contains all the attached files.
|
||||
|
||||
4. Copy the folders of the installed plugins and themes into new installation
|
||||
|
||||
5. Generate a session store secret
|
||||
|
||||
Redmine stores session data in cookies by default, which requires
|
||||
a secret to be generated. Under the new application directory run:
|
||||
rake generate_session_store
|
||||
|
||||
DO NOT REPLACE OR EDIT ANY OTHER FILES.
|
||||
|
||||
6. Migrate your database
|
||||
|
||||
If you are upgrading to Rails 2.3.5 as part of this migration, you
|
||||
need to upgrade the plugin migrations before running the plugin migrations
|
||||
using:
|
||||
rake db:migrate:upgrade_plugin_migrations RAILS_ENV="production"
|
||||
|
||||
Please make a backup before doing this! Under the new application
|
||||
directory run:
|
||||
rake db:migrate RAILS_ENV="production"
|
||||
|
||||
If you have installed any plugins, you should also run their database
|
||||
migrations using:
|
||||
rake db:migrate_plugins RAILS_ENV="production"
|
||||
|
||||
7. Clean up
|
||||
|
||||
Clear the cache and the existing sessions by running:
|
||||
rake tmp:cache:clear
|
||||
rake tmp:sessions:clear
|
||||
|
||||
8. Restart the application server (e.g. mongrel, thin, passenger)
|
||||
|
||||
9. Finally go to "Administration -> Roles & permissions" to check/set permissions
|
||||
for new features, if any
|
||||
|
||||
== Notes
|
||||
|
||||
* Rails 2.3.5 is required for versions 0.9.x and 1.0.x.
|
||||
|
||||
== References
|
||||
|
||||
* http://www.redmine.org/wiki/redmine/RedmineUpgrade
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
= Upgrade
|
||||
|
||||
The detailed upgrade instructions are located on the {official website}[https://www.chiliproject.org/projects/chiliproject/wiki/Upgrade]
|
||||
40
doc/git.rdoc
40
doc/git.rdoc
|
|
@ -1,40 +0,0 @@
|
|||
= Contributing to Redmine with git and github
|
||||
|
||||
(This is a beta document. If you can improve it, fork it and send a patch/pull request.)
|
||||
|
||||
The official repository is at http://github.com/edavis10/redmine
|
||||
|
||||
Official branches:
|
||||
|
||||
* master - is automatically mirrored to svn trunk. DO NOT COMMIT OR MERGE INTO THIS BRANCH
|
||||
* [0.6, 0.7, 0.8, 0.9, 1.0,...]-stable - is automatically mirrored to svn release branches. DO NOT COMMIT OR MERGE INTO THIS BRANCH
|
||||
* integration-to-svn-trunk - this branch is a git-only branch that will track master (trunk). Any code in here will be eventually merged into master but it may be rebased as any time (git-svn needs to rebase to commit to svn)
|
||||
* integration-to-svn-stable-1.0 - this branch is a git-only branch that will track the 1.0-stable branch in svn. Any code in here will be eventually merged into master and 1.0-stable but it may be rebased as any time (git-svn needs to rebase to commit to svn)
|
||||
|
||||
I (edavis10) might have some other branches on the repository for work in progress.
|
||||
|
||||
== Branch naming standards
|
||||
|
||||
Redmine has two kinds of development:
|
||||
|
||||
* bug fixes
|
||||
* new feature development
|
||||
|
||||
Both bug fixes and new feature development should be done in a branch named after the issue number on Redmine.org. So if you are fixing Issue #6244 your branch should be named:
|
||||
|
||||
* 6244
|
||||
* 6244-sort-people-by-display-name (optional description)
|
||||
* issue/6244 (optional "issue" prefix)
|
||||
* issue/6244-sort-people-by-display-name (optional prefix and description)
|
||||
|
||||
That way when the branch is merged into the Redmine core, the correct issue can be updated.
|
||||
|
||||
Longer term feature development might require multiple branches. Just your best judgment and try to keep the issue id in the name.
|
||||
|
||||
If you don't have an issue for your patch, create an issue on redmine.org and say it's a placeholder issue for your work. Better yet, add a brief overview of what you are working on to the issue and you might get some help with it.
|
||||
|
||||
== Coding Standards
|
||||
|
||||
Follow the coding standards on the Redmine wiki: http://www.redmine.org/wiki/redmine/Coding_Standards#Commits. Make sure you commit logs conform to the standards, otherwise someone else will have to rewrite them for you and you might lose attribution during the conversion to svn.
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
#clear the doc:app task et al
|
||||
Rake::Task["doc:app"].clear
|
||||
Rake::Task["doc/app"].clear
|
||||
Rake::Task["doc/app/index.html"].clear
|
||||
|
||||
namespace :doc do
|
||||
desc "Generate documentation for the application. Set custom template with TEMPLATE=/path/to/rdoc/template.rb or title with TITLE=\"Custom Title\""
|
||||
Rake::RDocTask.new("app") { |rdoc|
|
||||
rdoc.rdoc_dir = 'doc/app'
|
||||
rdoc.template = ENV['template'] if ENV['template']
|
||||
rdoc.title = ENV['title'] || "ChiliProject"
|
||||
rdoc.options << '--line-numbers' << '--inline-source'
|
||||
rdoc.options << '--charset' << 'utf-8'
|
||||
rdoc.rdoc_files.include('app/**/*.rb')
|
||||
rdoc.rdoc_files.include('lib/**/*.rb')
|
||||
rdoc.rdoc_files.include('README.rdoc')
|
||||
rdoc.rdoc_files.include('doc/*.rdoc')
|
||||
rdoc.main = 'README.rdoc'
|
||||
}
|
||||
end
|
||||
Loading…
Reference in New Issue