sulu-docs icon indicating copy to clipboard operation
sulu-docs copied to clipboard

Missing SuluAdminBundle Documentation

Open alexander-schranz opened this issue 1 year ago • 0 comments

The SuluAdminBundle configuration is currently missing (bundles/admin/index.rst):

There is already internal ticket on our side but we want to create the following 3 pages (including subpages) around the AdminBundle

1. Admin Class (bundles/admin/admin-class.rst)

  • Creating a Admin Class
  • Add Navigation Context
  • Basic Docs what ViewBuilders are (list of ViewBuilders)
  • 1.1 ViewBuilders (list to own docs bundles/admin/view-builders/*)
    • Docs for Every ViewBuilder and its special options. Always a simple and complex example
  • Security Contexts
  • Config & Config Keys
  • Override & Extend existing Admin classes (ViewBuilder, Navigation, ...)

2. List (bundles/admin/list.rst)

  • List Path Configuration (how to add a new directory containing forms)
  • Documentation List.xml simple property list (completly without any entity)
  • 1.1 Transformers (list to own docs bundles/admin/list-transformers/*)
  • Documentation List.xml usage as a query builder with an entity
  • Listmetadatavisitor

3. Form (bundles/admin/form.rst)

  • Form Path Configuration (how to add a new directory containing forms)
  • Form xml documentation equivalant to current template documentation in the book.
  • FormMetadataVisitor

3.1 Field Types (list to own docs bundles/admin/field-types/*)

- Documentation for every FieldType (simple example, complex example with all parameters, JSON format e.g. `{"ids": [1,2,3], "displayOption":"left"}`. Example of serialization on an entity. Add crosslink between content type and field type. Document field type specific parameters `request_parameters`, `resource_store_properties_to_request`, ... only in field type not in content type.Focus content type documentation on website development with real world examples

alexander-schranz avatar Aug 01 '22 12:08 alexander-schranz