К содержанию

Чего не хватает Вам в документации?

Дорогие участники сообщества!



В рамках развития сообщества и экосистемы CMS MODX мы хотели задать вам вопрос: Чего не хватает Вам в документации?

Просим Вас написать в комментарии:
— в чем сложность использования документации?
— какие разделы документации должны быть переосмыслены?
— какие разделы должны быть обновлены и дописаны?
— по каким дополнения находящимся в modstore и не только нужна документация и по каким конкретно моментам?

Просим Вас подробно ответить на вопросы. Все это поможет сделать наше сообщество лучше! Спасибо!
Иван Бочкарев
Иван Бочкарев
17 декабря 2020, 08:46
modx.pro
2 232
Реклама

Комментарии: 19

Николай Савин
Николай Савин Администратор
17 декабря 2020, 10:16
— Инструкция по консольному обновлению изображений по аналогии с ms2Gallery
— Инструкция по работе с корзиной и заказом посредством коротких API методов типа ms2-cart-add, ms2-order-submit
для тех случаев когда нужно создать заказ программно.
— Инструкция по простой реализации заказа в один клик используя готовый API из предыдущего пункта
    Николай Савин
    Николай Савин Администратор
    17 декабря 2020, 12:01
    Здесь я имел ввиду документацию по minishop2.
      Олег Щавелев
      Олег Щавелев Проверенный
      17 декабря 2020, 14:27
      Инструкция по консольному обновлению изображений по аналогии с ms2Gallery
      А есть в документации лови клац
    Николай
    Николай Старожил
    17 декабря 2020, 10:22
    Меня как человека который доку читает постоянно, раздражает то что она не актуализирована. К примеру тот же HybridAuth дока написана лет 5 назад, гугл и фейсбук уже вообще по другому работают и дока не актуальна от слова совсем. И такого вполне много.
      Иван Бочкарев
      Иван Бочкарев Администратор
      17 декабря 2020, 10:34
      Поэтому мы и просим, написать больше примеров для исправления ситуации
        Николай Савин
        Николай Савин Администратор
        17 декабря 2020, 12:00
        А еще можно взять и прислать улучшение.
        Александр Мельник
        Александр Мельник Проверенный
        17 декабря 2020, 11:16
        Вы о документации
        docs.modx.pro/
        или
        docs.modx.com/
        ?
          Иван Бочкарев
          Иван Бочкарев Администратор
          17 декабря 2020, 11:20
          docs.modx.pro/ — про эту.
          docs.modx.com/ — тут я, что было в моих силах сделал. Начиная от помощи в процессе переноса на новый сайт, внешним видом сайта, а также перевода на русский.
            Александр Мельник
            Александр Мельник Проверенный
            17 декабря 2020, 11:40
            Спасибо за это. За перевод, но больше всего — за смену внешнего вида. Для меня на прошлой версии было совсем не очевидно на каком ты пункте находишься в меню, в каком разделе. Сейчас стало гораздо приятнее для глаза и мозга.
              Иван Бочкарев
              Иван Бочкарев Администратор
              17 декабря 2020, 11:44
              Ну как мог — улучшил.
          Наумов Алексей
          Наумов Алексей Администратор
          17 декабря 2020, 15:02
          На этом сайте есть раздел Готовые решения modx.pro/solutions
          Возможно, часть публикаций отсюда, после проверки стоит структурировать и перенести (дать ссылки) в документацию.
          Так сказать сборник «золотых» готовых решений.
            Николай Савин
            Николай Савин Администратор
            17 декабря 2020, 16:03
            Составишь каталог кандидатов в документацию?
            Антон Тарасов
            Антон Тарасов Проверенный
            17 декабря 2020, 16:13
            Привет @Иван Бочкарев!

            docs.modx.pro/ — про эту.
            docs.modx.com/ — тут я, что было в моих силах сделал. Начиная от помощи в процессе переноса на новый сайт, внешним видом сайта, а также перевода на русский.
            А можно последние сведения с полей, что там думают наши «западные партнеры» и какая генеральная линия нашей партии, какая для РУ сообщества ветка более перспективная/актуальная? Или двигается по обеим?

            В первой преимущественно компоненты минишопа и прочие, созданные нашим сообществом, во второй — труды соратников по экосистеме *modx.com.

            Почему спрашиваю — в очередной раз возник «зуд» попереводить, поднакопилось, и для себя и для клиентов… хочется понять, как лучше двигаться, или куда ни напиши — все хорошо?! :)

            Что-то мелькало здесь, что-то в чатах, что-то в слаках… Полагаю, для выработки как теперь модно говорить «дорожной карты» и создан этот пост.
              Николай Савин
              Николай Савин Администратор
              17 декабря 2020, 19:12
              Данный пост создан в рамках улучшения нашей русскоязычной экосистемы.
              В основном сейчас идет плотная работа над минишопом. В рамках этой работы заговорили о документации. Решили ее оптимизировать.
              Если будут активные предложения по документации MODX в целом и ее улучшим. Но пока что речь идет о развитии docs.modx.pro и ждем предложений по оптимизации этого ресурса.
              Почему ждем и спрашиваем, вместо того чтобы просто взять да сделать? Да на самом деле есть большая проблема. С высоты опыта не очень понятно где именно и о чем не хватает информации. Вроде все понятно и так. Но это заблуждение конечно. Начинающим ребятам нужна более очевидная документация.
              R2m0x94 (Vasily)
              R2m0x94 (Vasily) Старожил
              17 декабря 2020, 19:26
              Когда пролистываешь вниз баг, оказываешься наверху. И такой баг уже довольно давно наблюдается. Спасибо
                Николай
                Николай Проверенный
                17 декабря 2020, 19:44
                Это скорее всего из-за рекламного баннера в самом низу, который подгружается не сразу. Ему бы фиксированную высоту задать
                Vladimir Alekhin
                Vladimir Alekhin Старожил
                21 декабря 2020, 13:54
                Было бы здорово иметь информацию по созданию CMP, в одном месте, работа с собственными пакетами. Но это огромный раздел затрагивающий и ExtJS. Я бы очень хотел когда-то такое увидеть.

                Плюсом в эту сторону было бы здорово и по CMPGenerator PRO более подробную документашку, помимо видео.
                  Антон Тарасов
                  Антон Тарасов Проверенный
                  09 марта 2021, 15:30
                  Работая с документацией последние дни и памятуя про желаемую кейсоориентированность, было бы здорово иметь некий промежуточный «котел», куда на первом этапе закидывались бы какие-то пользовательские сценарии (например, в ТГ MODX на днях вопрошали про особенности инсталляции MODX на отечественных хостингах, а на community.modx.com кто-то страдал с установкой IIS под Windows Server...), а вторым — отражались в документации, а-ля «готовые решения» и/или на docs.modx.com.

                  Тут акцент именно на формировании хорошей привычки такой сценарий увидеть — и в котел положить)) Добавить/дописать куда надо уже проще, была бы фактура.
                    Авторизуйтесь или зарегистрируйтесь, чтобы оставлять комментарии.
                    19