Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Добавил модуль для чтения документации #4

Merged
merged 2 commits into from
Apr 9, 2013

Conversation

Veteriuz
Copy link
Contributor

@Veteriuz Veteriuz commented Apr 4, 2013

в ответ на yupe/yupe#423

@im-kulikov
Copy link
Contributor

А можно посмотреть вариант в работе?
Не совсем понятно, как работать будет?

@Veteriuz
Copy link
Contributor Author

Veteriuz commented Apr 5, 2013

Могу показать скриншот
скриншот

@im-kulikov
Copy link
Contributor

Предлагаю сделать настройки для модуля,
то есть, чтобы можно было добавлять файлы.
Хранить подобные настройки можно, например
в каталоге data этого модуля, формат хранения
можно взять - json
Так же, стоит сделать возможность кеширования
настроек, с депенденсом на этот файл. ( http://www.yiiframework.com/doc/guide/1.1/ru/caching.data#sec-2 )
Будет очень удобно, как считаете?

@im-kulikov
Copy link
Contributor

Сможете осилить подобное?
Если нет - делайте пулл-реквест ко мне в репу, доделаю и смерджу.
Данный модуль как раз необходим на данный момент в мастер-ветке Юпи =)

@Veteriuz
Copy link
Contributor Author

Veteriuz commented Apr 9, 2013

на данный момент уже можно управлять списком файлов, делается это в настройках модулей (мой линк - http://yupe.loc/yupe/backend/modulesettings/documentation), если нужен json в data - переделаем)

@im-kulikov
Copy link
Contributor

Ок, я отпишу @xoma он посмотрит, если что напишет что по правкам =)

@yupe
Copy link
Owner

yupe commented Apr 9, 2013

Парни, привет!

Смотрите, что нам необходимо. Если кратко - нам нужно повторить модуль для документации, который используется на yiiframework.ru

Общие особенности:
1 Структура каталога с доками https://github.com/yiisoft/yii/tree/master/docs
2 Возможность вести доки на N-языках (деление по каталогам en, ru и т.д.)
3 Урл для прочтения доки примерно вот такой http://yiiframework.ru/doc/guide/ru/index (отображается вот этот файл https://github.com/yiisoft/yii/blob/master/docs/guide/ru/index.txt)
4 Сами файлы документации могут быть в 2-х формтах - MarkDown (расширение .md) и HTML (.html)

Требования к модулю:
1 В модуле должна быть переменная указывающая на корневую папку с доками
2 Должен быть контроллер который будет обработывать урл-ы типа http://yupe.ru/doc/guide/ru/index
Здесь doc - модуль, guide - каталог внутри основного каталога с доками, ru - язык (по сути тоже каталог), index - файл документации
3 Доки в фомате маркдаун должны кешироваться дабы каждый раз не рендерить его в html

@im-kulikov
Copy link
Contributor

О! По форматам - я за MarkDown, его редактировать куда проще.
Что касается рендеринга - да, будет круто его кешировать, тут я согласен

@yupe
Copy link
Owner

yupe commented Apr 9, 2013

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

yupe added a commit that referenced this pull request Apr 9, 2013
Добавил модуль для чтения документации
@yupe yupe merged commit 77c2d9a into yupe:master Apr 9, 2013
@yupe
Copy link
Owner

yupe commented Apr 9, 2013

Дополнительные требования к модулю вот тут #5

Спасибо за труд!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants