Forums / National / Russian / Идеи / Github интеграция.

Macik
#39811 2014-09-06 18:11
#39809 esclkm:

У гитхуба есть вот такой вот сервис: https://help.github.com/categories/20/articles

Ты про GitHub pages? Хочешь параллельно с отображением на сайте Котонти еще компилить доки и выкладывать на GHP?

Цель моего плагина: добавить возможность добавлять плагины сюда http://www.cotonti.com/extensions/ просто скормив ссылку на гитхубе.

Это понятно.

Но! если я солью ссылку на просто репозиторий - он дожен написать ошибку!

Он должен Прочитать файл setup - из которого понять: название плагина, его версию, его описание, версию котонти и категорию.

!но тут есть грабли: у меня setup файл лежит в корне, а у траста он обычно лежит в подпапкеб какие еще способы могут быть?

Да. Должен парсить всю структуру каталого репозитория.

что надо предусмпотреть?

Например, Варианты, когда кто-то засунул 2 плагина в репозиторий .

Еще надо извлекать файлы (README.md, README_ru.md, …) и на их основе делать страницы описания.

Дальше: как добавлять темы?

Отдельная, емкая тема. На вскидку — искать файлы theme.php там есть теги описание BEGIN_COT_THEME. Темы как правило ледат в отдельной папке по названию темы.

Можно подумать о едином файле описания загружаемых ресурсов Кота (типа composer.json) — плаг/модуль/тема/JS библиотека (в перспективе). Правда это еще одна сущность, но зато добавит четкости.

Еще надо подумать о расширении описания тем, на предмет ссылки на файл(ы) «скриншотов» темы.

Дальше: как вести именование текста? понятно, что readme файл . но у меня readme всегда на русском б а у траста на инглише. Как должны называться ридми файлы для других языков.

См. выше. Я для себя давно принял такой формат.

==================================================================================

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

понятно что по умолчанию будет синтаксис MD (но вот проблема : подсветка кода на разных языках программиования)

А в чем тут именно проблема? поясни.

Как мы будем определять описание и название каждого каталога?

например 

docs/

docs/start/ - где и как взять описание и текст данной папки? на разных языках? снова read me файлы? 

docs/admin/

Можно взять какойлибо стандарт. Например ГитБук. Они для этих целей используют файл SUMMARY.md, для языковых версий поддиректории (см. описание).

Или как прикрепить картинки? Куда и как их лить, видео, ссылку на демо

Редактирование доков будет через гитхаб, так? Значит все иллюстрации мы льем в отдельный каталог (например assets, как в ГитБук). В MD прекрасно вставляются ссылки на иллюстрации. Со ссылками на сторонний контент как обычно, как и сейчас, это просто ссылки на сторонний контент. Хочешь залей на cotonti.com и дай ссылку туда.  Что касается видео — аналогично (залей на видео зостинг, дай ссылку).

 

https://github.com/macik
правильный хостинг — https://goo.gl/fjCa1F