Task #27561

Complete documentation

Added by Karsten Dambekalns about 4 years ago. Updated almost 2 years ago.

Status:Accepted Start date:2008-07-15
Priority:Could have Due date:
Assigned To:- % Done:

84%
Category:- Documentation -
Target version:- Estimated time:2.00 hours
Sprint: Has patch:No
PHP Version: Complexity:

Description

'nuff said

Subtasks

Task #5927: Write documentation for Cache FrameworkResolvedKarsten Dambekalns

Task #3882: Document the Signal Slot featuresResolvedKarsten Dambekalns

Task #13977: Document incompatibility of Apache's MulitViews and the r...ResolvedKarsten Dambekalns

Task #672: Finish documentation about configuration in FLOW3ResolvedSebastian Kurfuerst

Task #3881: Complete documentation about MVCResolved

Task #27569: Document Routing features and setupResolvedBastian Waidelich

Bug #27640: Document property mapperResolvedSebastian Kurfuerst

Task #8923: Provide a Nginx Server Configuration for FLOW3Under ReviewChristian Müller

Task #27562: Update Persistence documentationResolvedKarsten Dambekalns

Task #27567: Reorder chaptersResolved

Task #27573: Update installation documentationResolvedKarsten Dambekalns

Task #27614: Update Package documentationResolvedKarsten Dambekalns

Task #29202: Provide a Cherokee Server Configuration for FLOW3New

Task #29266: Transfer "Introduction" chapter to ReSTResolvedKarsten Dambekalns

Task #35394: Document Routing feature "appendExceedingArguments"ResolvedKarsten Dambekalns

Task #29268: Transfer / Rewrite MVC chapterClosedRobert Lemke

Task #38037: Update FLOW3 manualResolved

Task #38038: Proofread FLOW3 manualAcceptedRyan J. Peterson

Bug #38004: Missing CheatSheet folder for Getting Started manualAcceptedKarsten Dambekalns

Task #38561: Create `Reflection` manual pageResolvedAdrian Föder

Task #38646: Create TypeConverter referenceResolvedKarsten Dambekalns

Task #38669: Create annotation referenceResolvedKarsten Dambekalns

Task #38680: Document configuration validationResolvedKarsten Dambekalns

Task #38944: Write chapter about command line interfaceResolvedRobert Lemke

Bug #39374: References to renamed / moved code in part IIResolvedKarsten Dambekalns

Associated revisions

Revision 90cad6b6
Added by Ryan J. Peterson about 3 years ago

[TASK] Add "Essential Design Patterns" to the guide

Re-uses some AOP verbage from part III of the guide.

Change-Id: I9255c9f5eedd377aa38bd7c39c9e79a857a93798
Related: #38037
Related: #27561
Releases: 1.1, 1.2

Revision 94d73f3a
Added by Ryan J. Peterson about 3 years ago

[TASK] Add "Essential Design Patterns" to the guide

Re-uses some AOP verbage from part III of the guide.

Change-Id: I9255c9f5eedd377aa38bd7c39c9e79a857a93798
Related: #38037
Related: #27561
Releases: 1.1, 1.2

Revision 439702c1
Added by Karsten Dambekalns about 3 years ago

[TASK] Add "Introduction" to the guide

Added introduction section for the guide.

Change-Id: I3941c3981f17214f98fda08b21a492f1adca9eb8
Related: #38037
Related: #27561
Releases: 1.1, 1.2

Revision efe74d51
Added by Karsten Dambekalns about 3 years ago

[TASK] Add "Introduction" to the guide

Added introduction section for the guide.

Change-Id: I3941c3981f17214f98fda08b21a492f1adca9eb8
Related: #38037
Related: #27561
Releases: 1.1, 1.2

Revision d743972f
Added by Adrian Föder about 3 years ago

[TASK] Correct typos in Coding Guidelines

This corrects some typos in PartV/CodingGuidelines of the
documentation.

Change-Id: I322c4ce5a9242ff5c22206d239bd1c7b86838f70
Related: #27561
Releases: 1.1, 1.2

Revision 219d22c8
Added by Adrian Föder about 3 years ago

[TASK] Correct typos in Coding Guidelines

This corrects some typos in PartV/CodingGuidelines of the
documentation.

Change-Id: I322c4ce5a9242ff5c22206d239bd1c7b86838f70
Related: #27561
Releases: 1.1, 1.2

Revision 522057e5
Added by Karsten Dambekalns almost 3 years ago

[TASK] Fix markup errors on documentation

Change-Id: I6dbe51e52430f3f1bfca0a6bae929a243c93a758
Related: #27561
Releases: 1.1, 1.2

Revision 6878b35d
Added by Karsten Dambekalns almost 3 years ago

[TASK] Fix markup errors on documentation

Change-Id: I6dbe51e52430f3f1bfca0a6bae929a243c93a758
Related: #27561
Releases: 1.1, 1.2

History

#1 Updated by Karsten Dambekalns almost 4 years ago

  • Target version deleted (1230)

#2 Updated by Karsten Dambekalns about 3 years ago

  • Target version set to 1.1
  • Has patch set to No

#3 Updated by Karsten Dambekalns almost 3 years ago

  • Target version deleted (1.1)

Ongoing task, removing target version.

Note to the audience: most of the crucial things have been documented by now!

#4 Updated by Jacob Floyd almost 3 years ago

There are five sections that still need a first draft:
  • Part III: Manual
    • Error and Exception Handling
    • Logging and Debugging
    • File Monitoring
    • Testing
  • Part IV: Deployment and Administration
And here are the resources I've gathered to help whoever ends up writing the chapters:

Part IV will need to explain TYPO3.Surf.

Also, while reworking the style of the manual, we'll need to create the glossary as it is quite sparse right now.

Also available in: Atom PDF