Skip to content

Instantly share code, notes, and snippets.

@feketegy
Last active December 21, 2015 20:59
Show Gist options
  • Star 1 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save feketegy/6365298 to your computer and use it in GitHub Desktop.
Save feketegy/6365298 to your computer and use it in GitHub Desktop.
Kohana Documentation TOC
1 General
1.1. About Kohana [1 page]
- On this page we talk a little bit about kohana, what it stands for, etc.
- server requirements
- kohana license
- link to forum, irc channel, stackoverflow, etc.
1.2. Change Log [1 page]
- maybe a redmine dump with the latest bugfix, features, etc.
1.3. Contributing [1 page]
- how to contribute
- github stuff
- coding guidelines
- redmine links, etc.
- unit testing
1.4. Upgrading from older versions
2. Getting Started
2.1. Installation
- how to install the latest version
2.2. Configuration
- how to configure the latest version
- how to setup bootstrap (merging: http://kohanaframework.org/3.3/guide/kohana/bootstrap)
- configuring modules (merging: http://kohanaframework.org/3.3/guide/kohana/modules)
2.3. Cascading Filesystem
2.4. Request Flow
2.5. Routing
2.6. MVC
- how it relates to KO
3. Learn More
3.1. Error Handling
- more detailed docs than the current page (http://kohanaframework.org/3.3/guide/kohana/errors) on how to do it properly
- also contains custom error pages ( http://www.kohana.dev/guide/kohana/tutorials/error-pages )
3.2. Logging
3.3. Autoloader
- PSR-0
- will also contain this page: http://kohanaframework.org/3.3/guide/kohana/autoloading
3.4. Request Handling
- http://kohanaframework.org/3.3/guide/kohana/requests
- talk about getting POST data, etc.
- link to security -> user input and validation
3.5. Sessions & Cookies
3.6. Database
3.7. Cache
3.8. Minion (CLI)
4. Security
4.1. General security guidelines
- will contain XSS (http://kohanaframework.org/3.3/guide/kohana/security/xss)
- csrf
- database security (sql injection, etc.)
- encryption (http://kohanaframework.org/3.3/guide/kohana/security/encryption)
4.2. User input and validation
5. Advanced Usage
5.1. HMVC
5.2. View-Models
5.3. Templating systems
- mainly mustache
5.4. Creating Modules
6. Other Resources
- curated user tutorials
- best practices
@malkintower
Copy link

Hi, good work.

I suggest removing "5.3. Templating systems" as it is discussing optional modules. Perhaps change "5.4. Creating Modules" into "5.3. Creating Modules and using 3rd party modules". You could either list all compatible modules here or reference http://kohana-modules.com/

No doubt there will be numerous Templating systems discussed under "curated user tutorials".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment