Документация Flexberry Ember

[KollegOFF]

Текущая структура документации

Flexberry Ember

• О Flexberry Ember
  • О модуле (статья|файл)
• Формы и контролы
  • ember-flexberry - ссылка на ember-flexberry » Начало работы » О модуле
• Доступ к данным
  • ember-flexberry-data - ссылка на ember-flexberry-data » Начало работы » О модуле
• Инструментарий разработки
  • Ember-CLI via Docker Image (статья|файл)
  • Обновление Ember-CLI (статья|файл)

ember-flexberry

• Начало работы
  • О модуле (статья|файл) f4e704b
    • Удалить статью.
  • Производительность ember-приложений (статья|файл)
  • Доступ к Ember-приложению извне (статья|файл)
• Формы
  • О формах в приложении (статья|файл)
  • Router (статья|файл)
  • Route (статья|файл)
  • Controller (статья|файл)
  • Шаблон формы (статья|файл)
  • Форма редактирования (статья|файл)
  • Значения по умолчанию (статья|файл)
  • Режим "только чтение" (статья|файл)
  • Форма без доп. элементов (статья|файл)
  • Отображение ошибок на формах (статья|файл)
• Элементы управления
  • Общее описание (статья|файл)
  • File (статья|файл)
  • Flexberry toggler (статья|файл)
  • UI Message (статья|файл)
  • Отображение ошибок в приложении (статья|файл)
• Списковые компоненты
  • Flexberry Objectlistview (статья|файл)
  • Блокирование отдельных ячеек списка (статья|файл)
  • Настройка фильтров на списках (статья|файл)
  • Пользовательские кнопки для списков (статья|файл)
  • Инструменты работы с объектами на списках (статья|файл)
  • Изменение ширины столбцов списка (статья|файл)
  • Настройка панели управления для списков (статья|файл)
  • Поиск по всем атрибутам (статья|файл)
• Groupedit
  • Flexberry Groupedit (статья|файл)
  • Редактирование детейлов в отдельном роуте (статья|файл)
• Lookup
  • Лукапы в ember-flexberry приложении (статья|файл)
  • Настройка поднимаемой по лукапу формы (статья|файл)
  • Автодополнение в лукапе (статья|файл)
• Сервисы
  • О модуле (статья|файл)
  • Сервис логирования (статья|файл)
  • Сервис блокировок (статья|файл)
  • Сервис пользовательских настроек (статья|файл)
  • Сервис состояния загрузки (статья|файл)
• Настройка приложения
  • Интернационализация приложения (статья|файл)
• Мобильное представление
  • Использование Apache Cordova (статья|файл)
  • Мобильные шаблоны (статья|файл)
• Темы оформления
  • Поддерживаемые темы оформления (статья|файл)
  • Внутреннее устройство тем (статья|файл)
  • Переход на новые темы оформления (статья|файл)
  • Создание новых тем (статья|файл)
• Генерация
  • Генератор приложения (статья|файл)
  • Blueprints кодогенерация (статья|файл)

ember-flexberry-data

• Начало работы
  • О модуле (статья|файл)
    • Удалить статью.
• Модели и проекции
  • Модель (статья|файл)
  • Проекции в моделях (статья|файл)
  • Адаптеры (статья|файл)
  • Сериализаторы (статья|файл)
  • Перечисления (статья|файл)
  • Валидация модели (статья|файл)
  • Валидация даты и времени (статья|файл)
• Язык запросов
  • Возможности языка запросов (статья|файл)
• Работа с файлами
  • Поддержка работы с файлами (статья|файл)
• Оффлайн
  • Поддержка офлайна (статья|файл)
• OData & JSON API
  • Поддержка OData (статья|файл)

Новая структура документации

• Начало работы - общие статьи, инструменты, FAQ.
  • Введение
    • Исходная статья: Flexberry Ember » О Flexberry Ember » О модуле
    • Описать в общих чертах, начальные требования, ссылки.
  • Ember-CLI via Docker Image
    • Исходная статья: Flexberry Ember » Инструментарий разработки » Ember-CLI via Docker Image
    • Исправить в соответствии с требованиями к статьям.
  • Обновление Ember-CLI
    • Исходная статья: Flexberry Ember » Инструментарий разработки » Обновление Ember-CLI
    • Написать статью в соответствии с требованиями к статьям.
• Учебник - пошаговое руководство по созданию приложения, от генерации до развертывания.
  • Придумать и описать содержимое учебника.
• Приложение Flexberry Ember - статьи не попавшие в другие разделы.
  • Производительность ember-приложений
    • Исходная статья: ember-flexberry » Начало работы » Производительность ember-приложений
    • Исправить в соответствии с требованиями к статьям.
  • Доступ к Ember-приложению извне
    • Исходная статья: ember-flexberry » Начало работы » Доступ к Ember-приложению извне
    • Исправить в соответствии с требованиями к статьям.
  • Интернационализация приложения
    • Исходная статья: ember-flexberry » Настройка приложения » Интернационализация приложения
    • Исправить в соответствии с требованиями к статьям.
  • Использование Apache Cordova
    • Исходная статья: ember-flexberry » Мобильное представление » Использование Apache Cordova
    • Исправить в соответствии с требованиями к статьям.
  • Мобильные шаблоны
    • Исходная статья: ember-flexberry » Мобильное представление » Мобильные шаблоны
    • Исправить в соответствии с требованиями к статьям.
  • Генератор приложения
    • Исходная статья: ember-flexberry » Генерация » Генератор приложения
    • Исправить в соответствии с требованиями к статьям.
  • Blueprints кодогенерация
    • Исходная статья: ember-flexberry » Генерация » Blueprints кодогенерация
    • Исправить в соответствии с требованиями к статьям.
• Формы - формы списков и редактирования, их роуты, контроллеры, шаблоны.
  • Придумать и описать содержимое раздела.
  • Исправить в соответствии с требованиями к статьям, все статьи из раздела ember-flexberry » Формы.
• Работа с данными
  • Исправить в соответствии с требованиями к статьям, все статьи из раздела ember-flexberry-data.
  • Составить перечень недостающих статей.
• Компоненты - статьи с руководством по каждому компоненту.
  • Исправить в соответствии с требованиями к статьям, все статьи из раздела ember-flexberry » Элементы управления. Повысить качество статей про компоненты ember-flexberry #56
  • Исправить в соответствии с требованиями к статьям, все статьи из раздела ember-flexberry » Списковые компоненты. Документация компонента flexberry-objectlistview #45
  • Исправить в соответствии с требованиями к статьям, все статьи из раздела ember-flexberry » Groupedit. Документация компонента flexberry-groupedit #47
  • Исправить в соответствии с требованиями к статьям, все статьи из раздела ember-flexberry » Lookup. Документация компонента flexberry-lookup #46
  • Составить перечень недостающих статей.
• Сервисы
  • Исправить в соответствии с требованиями к статьям, все статьи из раздела ember-flexberry » Сервисы.
  • Составить перечень недостающих статей.
• Темы оформления
  • Исправить в соответствии с требованиями к статьям, все статьи из раздела ember-flexberry » Темы оформления.
  • Составить перечень недостающих статей.
• Справочники по API
  • ember-flexberry Автодокументация для ember-flexberry и ember-flexberry-data #28
    • Встроить автодокументацию по ember-flexberry, можно добавить версионирование.
  • ember-flexberry-data Автодокументация для ember-flexberry и ember-flexberry-data #28
    • Встроить автодокументацию по ember-flexberry-data, можно добавить версионирование.

Дополнительно

• Прописать требования к статьям в документации. Обновить статью по правилам оформления статей #24
• В классах, в комментарии для автодокументации, перечислить ссылки на статьи в документации.
• Указывать версии только в справочниках по API.