MInor fixes and starting rewrite documentation #35
Conversation
| относящемуся к сообществу, будь то Slack, GitHub, ресурс сообщества ORCHID, личная беседа или что-то еще. | ||
| вы становитесь частью чего-то большого. Сотрудничаете с людьми со всего мира, | ||
| помогаете людям делать свои компьютеры восхитительными, но вместе с этим появляется обязательство следовать правилам, которые обеспечивают наиболее комфортную среду для всех участников. | ||
| Следующие правила должны соблюдаться в любое время и в любом месте, относящемуся к сообществу, будь то Slack, GitHub, ресурс сообщества ORCHID, личная беседа или что-то еще. |
There was a problem hiding this comment.
Slack канал совсем не большой и не особенно поддерживаеться, думаю имеет смысл заменить на Telegram
There was a problem hiding this comment.
Ааа, ну там вроде так и было написано
|
|
||
| > **Обратите внимание!** Здесь вы не найдете пояснения к работе с фреймворком [«Laravel»](http://laravel.su/docs), с которой данная платформа непосредственно связана. Прежде чем продолжить, настоятельно рекомендуем оснакомиться с [последней версией документации «Laravel»](https://laravel.com/docs/). |
There was a problem hiding this comment.
Как по мне, странно, что Laravel дважды упоминаеться в одном обзаце при этом с разными ссылками.
There was a problem hiding this comment.
Ну, не знаю просто насколько ты против убрать русский устаревший перевод. У лараверя хороший английский с документации
There was a problem hiding this comment.
У меня была договорённость с laravel.su, что они дают ссылку на меня, а я на них.
Пока мы оба исполняем эти условия, мне не хотелось их нарушать.
|
|
||
|
|
||
| ## Введение | ||
|
|
||
| ## Начало работы |
There was a problem hiding this comment.
Начало работы ассоциируеться с тем, что мне уже пора расчихлять IDE и начинать, что-либо делать.
Но тут лишь поясняеться, что делает пакет и за счёт чего обеспечиваеться "эффективная" разработка.
Может быть имеет смысл вообще перенести абзацы и не делить на разделы. Просто Введение и там уже сначало пояснение "ORCHID - это пакет для создания приложений", а уже затем предупреждение, что руководство не поясняет фреймворк?
There was a problem hiding this comment.
Мне показалась эта информация не сильно для кого либо знаючущей, и я решил переместить, просто в конце, по едее ее вооьше можно устрать, понятное дело что на сайте написано именно то, о чем сайт, а не про ларавель
Ну да, "Введение" все-таки помягче звучит
|
|
||
| - **Уровня управления ресурсами** - обеспечивает хранение данных, как правило реализуется средствами систем управления базами данных (MySQL,PostgreSQL,Microsoft SQL Server,SQLite). | ||
| 3. **Уровнь управления ресурсами** - обеспечивает хранение данных, как правило реализуется средствами [СУБД](https://ru.wikipedia.org/wiki/%D0%A1%D0%B8%D1%81%D1%82%D0%B5%D0%BC%D0%B0_%D1%83%D0%BF%D1%80%D0%B0%D0%B2%D0%BB%D0%B5%D0%BD%D0%B8%D1%8F_%D0%B1%D0%B0%D0%B7%D0%B0%D0%BC%D0%B8_%D0%B4%D0%B0%D0%BD%D0%BD%D1%8B%D1%85) (MySQL, PostgreSQL, Microsoft SQL Server, SQLite). |
There was a problem hiding this comment.
Хм, давай не будем сокращать до СУБД, потому что каждый раз придёться давать ссылку, при этом если человек не знаком до этого с этим опеределением, для него есть пояснение (MySQL, PostgreSQL, Microsoft SQL Server, SQLite), ну хоть какую то БД он должен знать.
There was a problem hiding this comment.
Зачем кадлый раз давай ссылку? Один раз в начале, мне кажется можно запомнить, ну ладно, верну полное название и это напишу в скобочках? Чтобы аббревиатура зрительно запомнилась, в остальном согласен
|
|
||
|
|
||
|  | ||
|
|
||
| Сокращение времени разработки непосредственно связано с распределением обязанностей между каждым из уровней. Это особенно заметно, когда необходимо создавать вспомогательный код, в то время как, большую часть действительно полезной работы берёт на себя прикладной слой. | ||
| Сокращение времени разработки, непосредственно связано с распределением обязанностей между каждым из уровней нашей архитектуры. Это особенно заметно, когда необходимо создавать вспомогательный код, в то время как, большую часть действительно полезной и практической работы берёт на себя слой (Layout). |
There was a problem hiding this comment.
Полностью искажён смысл предложения. Ответственность берёт на себя именно прикладной слой, который мы описываем выше, в нашем случае это именно фрейворк laravel.
There was a problem hiding this comment.
Переформулирую, да, хочу избавить от слова прикладной, оно устаревает
| - Генерация `HTML` шаблонизатором `Blade` или фреймворком `Vue`. | ||
| - Использование `ORM` или хранимых процедур. | ||
| - Генерация `HTML` шаблонизатором `Blade` или фреймворком `Vue`, | ||
| - Использование `ORM` для упращения работы с БД или хранимых процедур. |
There was a problem hiding this comment.
Характеристика "для упращения работы с БД" подходит как к ORM, так и хранимых процедур.
Понятное дело, что каждая перечисленная технология, улучшать свою область, но тут именно пример противопоставлений, что для одних и тех же задач могут использоваться различные технологии.
Показывающий, что пользователь с пакетом так же будет их решать, только иначе.
Давай вернём умерём это уточнение, так же по идеи если мы ставим запятую, то должны начать с прописной буквы, с заглавным подходят только точка и точка с запятой.
Исправил пару ошибок и переписал первую страницу документации в качестве примера