Дискуссия: Расширения и документация yii

Уже исправленные репорты или принятые предложения
Аватара пользователя
samdark
Администратор
Сообщения: 8695
Зарегистрирован: 2009.04.02, 13:46
Откуда: Воронеж
Контактная информация:

Re: Дискуссия: Расширения и документация yii

Сообщение samdark » 2012.11.07, 15:09

Ответил в общих вопросах.

Damange
Сообщения: 11
Зарегистрирован: 2010.05.17, 16:30
Откуда: Нижневартовск
Контактная информация:

Re: Дискуссия: Расширения и документация yii

Сообщение Damange » 2012.11.08, 10:36

Sam Dark писал(а):Ответил в общих вопросах.
Читаю вашу книгу... Половина вопросов сразу отпала...
Может стоит в официальной документации, в конце разделов сделать блок:
"более подробно данная тема описана: в Главе ХХ книги АВС, в рецепте %%%, рецепте %%%, статья на хабре %%%, тема форума %%%"

Рядом с этой информацией можно разметить данные о качестве источника и о сложности примера.
Таким образом, если у изучающего возникнут вопросы - он сможет самостоятельно изучить дополнительные материалы.


Еще идея, но уже по форуму.
Быть может стоит сделать подразделы в общих вопросах: АR, DAO, Route, Widget... и так далее.
В заголовках тем-вопросов ставить [OK] или любой символ, означающий что ответ на вопрос дан.

Таким образом форум будет отличным дополнением к документации. А сейчас - сложновато что то найти.

Еще вариант, сделать внутреннюю справочную систему по принципу http://www.askdev.ru/.

Так же можно добавить ссылки на популярные ресурсы, содержащие информацию по Yii (вроде видел где то нечто подобное):
http://habrahabr.ru/hub/yii/
http://www.askdev.ru/tagged/yii
http://stackoverflow.com/questions/tagged/yii
и так далее...

И последнее.
Необходим список OpenSource проектов на Yii. Просто одна страница или один пост, в котором будет ссылка на репозиторий, сайт и краткое описание (blog, crm...). Искать среди завершенных проектов сложно.

Аватара пользователя
samdark
Администратор
Сообщения: 8695
Зарегистрирован: 2009.04.02, 13:46
Откуда: Воронеж
Контактная информация:

Re: Дискуссия: Расширения и документация yii

Сообщение samdark » 2012.11.08, 11:31

Да, интересный вариант. Был бы рад таким вот подборкам ссылок и мест, где они были бы кстати.

Форум не QA, не все темы строятся по прниципу вопрос-ответ.

http://rmcreative.ru/wiki/yii

Аватара пользователя
resurtm
Сообщения: 299
Зарегистрирован: 2010.12.19, 09:13
Откуда: Казахстан, Алма-Ата
Контактная информация:

Re: Дискуссия: Расширения и документация yii

Сообщение resurtm » 2012.11.13, 13:28

Damange писал(а):Необходим список OpenSource проектов на Yii. Просто одна страница или один пост, в котором будет ссылка на репозиторий, сайт и краткое описание (blog, crm...). Искать среди завершенных проектов сложно.
http://suriyanphp.blogspot.in/2012/06/l ... -with.html

skit
Сообщения: 130
Зарегистрирован: 2012.10.08, 12:50
Откуда: Сибирь
Контактная информация:

Re: Дискуссия: Расширения и документация yii

Сообщение skit » 2012.12.18, 13:23

Как бальзам на сердце :) Я уже думал, что не дано мне, а оказывается это проблема остро стоит. Подписываюсь под первым постом.

Примеров можно сказать нет, это не документация, а памятка, видимо чтобы разработчики сами не забыли. Единственный толк от нее, это список методов и параметров. Но так я изучал CI и хоть Joomla и Drupal. Вообще (правда опыта не так много) не видел качественной документации. Пришел к выводу, если лень копаться в коде и изучать английский, можно менять профессию.
Но вот в API Drupal есть просто сама функция и кто ее вызывает. Это прекрасно, видно сразу как оно работает, пять минут и картина проясняется, т.е. кликая мышкой по ссылкам, можно как бы пройтись дебагером, полазить в коде, но только по нужным местам исключая лишнее и экономя время. Примеры использования можно посмотреть в разделе вызова функции, тут становиться ясно, зачем такой огромный массив передается, например или почему в него нельзя добавить свою пару. Можно легко найти схожие функции и посмотреть разницу, тут же написать свою и расширить функционал. ВАЖНО! Самое главное, документация должна показывать работу фреймворка, а не какое огромное количество супер методов и классов там есть. На мой взгляд этого вполне достаточно, все остальное придет с опытом. Самое главное, чтобы было понятно как работает та или иная функция, именно как работает, тогда вопрос в ее применении отпадет сам собой. Такое сравнение (для взаимопонимания), можно ребенку дать фонарик и объяснить зачем он, а можно просто показать как он включается, и пару слов, как бы классифицируя предмет. Какая документация? Принимает батарейки и лампочку, параметр кнопка устанавливаем в true и на выходе получаем свет. А что делать если не работает? Просто показать схему где будет ясно, что сели батарейки или загнулся контакт кнопки, или перегорела лампочка. Определить причину уже не сложно. Но я сейчас трачу кучу времени, на выяснения причины. Но видимо по другому ни как.

Ну вот realtime, банально, делаю маленький сайтик, проба пера. Я не знаю как определить правильное решение, ну вопрос не тянет на вопрос, уверен нет смысла спрашивать у сообщества, ведь все и так понятно, всем, только не мне.
Выход: разложить по полочкам, подробно изучить код, потратить лишний месяц на все возможные изучения.
Минусы: потрачена куча времени на изучение. Но можно было бы в рамках документации, это было бы на много быстрее.
Плюсы: теперь я знаю более глубоко работу фреймворка и списка свойств и методов в документации, мне вполне хватает.
Лучший вариант: Документация показывает работу фреймворка, а не количество инструментов, которые непонятно как использовать.

И не много философии. Я вообще музыкант и заметил такую вещь. Нет, это можно не читать уже все сказано.
Когда не было видюх, книг, сотен уроков, предмет воспринимали чувствами. Например, новых виртуозных гитаристов, практически нет. Но те кто сейчас виртуозы, они раньше, на заезженной, сотню раз перекопированной пленке и старом магнитофоне пытались услышав, понять как выполняется тот или иной прием или в принципе создавали нечто новое. Представляете сколько дров нужно было наломать, прежде чем получится. И ведь постоянно тревожит момент, что это на самом деле не так.Огромный стимул к постоянному совершенствованию. А сейчас включил видео, скачал с торрента программу с кряком, пару уроков в сети и "тот же" результат. В книге Лукаса по freeBSD, он пишет, что в его молодости системный администратор защищал докторскую диссертацию и имел минимум два высших образования, более того он понимал как работают команды на машинном уровне, а сейчас системный администратор может быть совсем не образован. И где сейчас эти сис.админы старой закалки? Уверен, это те кто двигает науку вперед изобретая всякого рода питоны и пэхапы. А мы, дети уроков по программированию, не можем (я про себя) разобраться с параметрами какого-то класса, который всего лишь колпачок на макушке большого дерева запросов и ответов. Мое мнение обычно отличается, думаю и в этом случае. Назвался груздем, полезай в кузовок. Кодер? Долби до победного и чем больше тем лучше. Ведь MVC это всего лишь обертка и слава тому, кто решился разобраться на чем она держится. Но в данном вопросе я таки солидарен с автором темы, документация на Yii, должна быть лучше. Но раз есть те кто свободно работают на Yii, значит все таки есть другие пути.

Аватара пользователя
samdark
Администратор
Сообщения: 8695
Зарегистрирован: 2009.04.02, 13:46
Откуда: Воронеж
Контактная информация:

Re: Дискуссия: Расширения и документация yii

Сообщение samdark » 2012.12.18, 13:36

У меня ощущение, что вы пользуетесь документацией по API, но как-то пропустили полное руководство, создание блога и кучу рецептов…

А по документации, если есть конкретные предложения, в каком месте на что сослаться и что упомянуть — пишите, попробуем добавить.

skit
Сообщения: 130
Зарегистрирован: 2012.10.08, 12:50
Откуда: Сибирь
Контактная информация:

Re: Дискуссия: Расширения и документация yii

Сообщение skit » 2012.12.18, 18:01

Спасибо за ваш вклад и скорый ответ.

Сейчас есть много вопросов, но пока я намерен адаптироваться в доках, потом сделаю конкретные предложения. Главное, что есть заинтересованные люди :) Вместе с руководством выполнил предложенные упражнения, но по окончанию, оказалось, все, что мне реально нужно ни как не описано. Видимо нужно действовать по аналогии, а тут масса вариантов, не предвиденных результатов и прочее прочее.

Ну вот например показано как добавить запись, но мне нужно добавить десяток записей разом. Все логично, вызываю в цикле, все те же save() и beforeSave(), ан нет, есть какие-то нюансы. Насколько, помню в руководстве на CI они были указаны, мол если нужно добавить несколько записей, то нужно сделать так и так и вот ссылки (см. API). Пишут программисты, очевидно же какие инструменты часто используются. Если описано достаточно повседневных примеров использования методов фреймворка, то через неделю уже привыкаешь к самой идее. Еще важно, чтобы можно было работать только с доками не обращаясь на форум, как минимум до определенной планки, а так приходиться минимум месяц пробивать дорогу. А на форуме то и дело должны проскальзывать сообщения: "см. доки, все есть...". Примитивный блог в руководстве лишь показывает, что на Yii можно работать, но из этого я не могу понять как ориентироваться в его инструментах, создавая проект отличный, хотя бы немного, от того, что представлено в руководстве. У меня знакомый работал с Yii в конторе, что не спрошу - не знает. Да, у них большой сайт на Yii, но это тот же блог в руководстве, только в профиль. Чуть влево или вправо уже не знает.
Но это может из-за того, что я не внимателен, по этому пока вопросов нет.
В идеале я вижу это так: первое время сообщество помогает научиться пользоваться доками или помогает в них адаптироваться. Те кто реально шарит тратит мало времени или вообще не тратит на мелочи. А так приходиться создавать те же доки только в виде свалки на форуме, нежели упорядоченно и в одной ветке. Не продуктивно. Да, кстати в CI, хорошие обсуждения с форума вносятся в вики. Не сам топик, а уже готовый мануал. Это можно просто сразу взять за практику.
На следующем этапе идет обсуждение реализации не очевидных задач или поиск наиболее короткого пути, обмен опытом.
На третьем этапе участники мозгуют над реально сложными задачами.
Иначе говоря доки, это как конституция, это основа, туда можно заслать любого с полной уверенностью. На недофоруме Друпала, радуют постоянные ссылки в доки. Они должны помочь "ходить" самостоятельно. Все должно быть очевидно.

Аватара пользователя
samdark
Администратор
Сообщения: 8695
Зарегистрирован: 2009.04.02, 13:46
Откуда: Воронеж
Контактная информация:

Re: Дискуссия: Расширения и документация yii

Сообщение samdark » 2012.12.18, 20:11

Доку к CI я частично переводил и дописывал :) Так вот, могу сказать, что она проще в изучении отчасти потому, что сам фреймворк не такой масштабный и гибкий. То есть просто предмет изучения проще.

На тему wiki, у нас тоже такое есть аж в двух вариантах:

http://yiiframework.ru/doc/cookbook/ru/index
http://www.yiiframework.com/wiki/

skit
Сообщения: 130
Зарегистрирован: 2012.10.08, 12:50
Откуда: Сибирь
Контактная информация:

Re: Дискуссия: Расширения и документация yii

Сообщение skit » 2012.12.23, 06:44

Ну вот, как я и думал. При детальном рассмотрении документация справляется, просто охота все и сразу (о себе, из своего поста).
Есть предложение по улучшению. Было бы не плохо сделать некое оглавление, в идеале с якорями. Я забыл где видел описание нужной сейчас функции, приходиться все открывать и просматривать, что запутывает. А так открыл, оглавление глянул, сразу видно есть там искомый материал или нет. Согласен, можно использовать поиск, но это потом, когда картина документации в голове будет отложена и будет очевидно, что именно нужно. Второй плюс, сразу видна структура документа, иначе читаешь об одном, потом видишь что-то еще, потом еще один сюрприз, когда вообще ничего не понятно, становиться совсем темно :) Чисто психологический момент.
Речи идет как о создании блога, так и о полном руководстве.
Пример оглавления (ссылка с поля боя http://www.yiiframework.ru/doc/guide/ru/topics.auth)
  • Аутентификация и авторизация
  • Определение класса Identity
  • Хранение паролей в базе данных
  • Вход и выход
  • Вход на основе cookie
  • Фильтр контроля доступа
  • и т.д.
Может, это уже было предложено раньше, не читал.
Открыл ссылку в этой статье на Yii wiki, а там как раз есть то, о чем я говорю. И я сразу увидел нужный заголовок "Generate a Blowfish salt".

Аватара пользователя
samdark
Администратор
Сообщения: 8695
Зарегистрирован: 2009.04.02, 13:46
Откуда: Воронеж
Контактная информация:

Re: Дискуссия: Расширения и документация yii

Сообщение samdark » 2012.12.23, 14:58

На http://www.yiiframework.com/doc/guide/1 ... opics.auth есть оглавление. На .ru я ещё не успел прикрутить.

skit
Сообщения: 130
Зарегистрирован: 2012.10.08, 12:50
Откуда: Сибирь
Контактная информация:

Re: Дискуссия: Расширения и документация yii

Сообщение skit » 2012.12.24, 19:52

мая инглиш еще учится :) Мне не легко сходу с ориентироваться в принципе в доке, тем более в англ.
Может, по большому счету, уровень вхождения включает знание английского. Упрощает то 100%. Тогда может поставите сервис как реформал: к экрану прилепленный "оставить отзыв", а там есть предложения, обсуждения и т.п. Я предлагаю "это", сервис позволяет сделать предложение принятым, т.е. в стадию разработки. Может на Yii, что то есть уже. Ведь уже есть куча планов, может не нужно всем их по второму разу придумывать, а кто-то сможет непосредственно помочь в реализации.

Аватара пользователя
samdark
Администратор
Сообщения: 8695
Зарегистрирован: 2009.04.02, 13:46
Откуда: Воронеж
Контактная информация:

Re: Дискуссия: Расширения и документация yii

Сообщение samdark » 2012.12.24, 22:22

Там русская документация рядом, если что. Реформал штука, конечно, занятная. Может как-нибудь прикрутим.

HouseMafia
Сообщения: 20
Зарегистрирован: 2013.01.30, 00:58
Контактная информация:

Re: Дискуссия: Расширения и документация yii

Сообщение HouseMafia » 2013.01.30, 23:55

;)
Последний раз редактировалось HouseMafia 2013.06.18, 23:41, всего редактировалось 1 раз.

HouseMafia
Сообщения: 20
Зарегистрирован: 2013.01.30, 00:58
Контактная информация:

Re: Дискуссия: Расширения и документация yii

Сообщение HouseMafia » 2013.06.18, 23:33

snowflake писал(а):[quote="Psih"
Вообще, у меня появилась только что такая мысль, что если б до официального описания классов добавить такую же штуку (можно вообще на другом домене) где для каждого класса просто приводить несколько примеров его использования - вопрос по документации закрылся полностью и они могли бы жить отдельно друг от друга. Как идея?
Я только ЗА! Т.к я можно сказать "0" в этом деле однако уже по мере прохождения накапливаю материал. поскольку много инфы о том что это такое но нет ни слова как же оно на практике. Те кто это все уже прошли им и дела нету ))

Аватара пользователя
resurtm
Сообщения: 299
Зарегистрирован: 2010.12.19, 09:13
Откуда: Казахстан, Алма-Ата
Контактная информация:

Re: Дискуссия: Расширения и документация yii

Сообщение resurtm » 2013.06.19, 06:45

Как насчёт отдельного репозитория на Гитхабе для таких примеров с кодом? В организации yiisoft на Гитхабе уже есть репозиторий yii2-examples, но он пока приватный и не виден всем. Собственно для решения этой цели он и создавался.

Ответить