-
-
Notifications
You must be signed in to change notification settings - Fork 145
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
MInor fixes and starting rewrite documentation #35
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,40 +5,38 @@ extends: _layouts.documentation.ru | |
section: main | ||
--- | ||
|
||
## Добро пожаловать | ||
## Введение | ||
|
||
Это руководство содержит справочную информацию для создания бизнес-приложений с использованием платформы, при этом | ||
не поясняет документацию фреймворка. Если вы уже знакомы с ним, перейдите к прочтению следующих глав, иначе | ||
рекомендую прочитать документацию [«Laravel»](http://laravel.su/docs) от начала до конца. | ||
Данное руководство, содержит подробное объяснение, как создавать бизнес-приложения при помощи платформы — **ORCHID**, которая заметно увеличит скорость вашей разработки. | ||
|
||
> **Обратите внимание!** Здесь вы не найдете пояснения к работе с фреймворком [«Laravel»](http://laravel.su/docs), с которой данная платформа непосредственно связана. Прежде чем продолжить, настоятельно рекомендуем оснакомиться с [последней версией документации «Laravel»](https://laravel.com/docs/). | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Как по мне, странно, что Laravel дважды упоминаеться в одном обзаце при этом с разными ссылками. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ну, не знаю просто насколько ты против убрать русский устаревший перевод. У лараверя хороший английский с документации There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. У меня была договорённость с |
||
|
||
> Для предложения улучшений этого руководства, [создайте новый issue](https://github.com/orchidsoftware/orchid.software/issues). | ||
При появлении вопросов или нахождения ошибки по документации, пожалуйста, укажите главу и сопутствующий текст, что бы указать на ошибку. | ||
|
||
|
||
## Введение | ||
|
||
## Начало работы | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Начало работы ассоциируеться с тем, что мне уже пора расчихлять IDE и начинать, что-либо делать. Может быть имеет смысл вообще перенести абзацы и не делить на разделы. Просто There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Мне показалась эта информация не сильно для кого либо знаючущей, и я решил переместить, просто в конце, по едее ее вооьше можно устрать, понятное дело что на сайте написано именно то, о чем сайт, а не про ларавель Ну да, "Введение" все-таки помягче звучит |
||
|
||
**ORCHID** - это пакет для создания приложений в стиле администрирования на фреймворке Laravel. Позволяет абстрагировать общие шаблоны бизнес-приложений, чтобы разработчикам было легко реализовывать красивые и элегантные интерфейсы без особых усилий. Основными местами применения являются: backoffice-приложения, админ панели, системы управления контентом и т.п. | ||
|
||
|
||
## Почему разработка станет быстрее? | ||
|
||
Классическое веб приложение представляет собой подсистему с общей трёхъярусной архитектурой, которая состоит из: | ||
Классическое веб-приложение представляет собой подсистему с общей трёхъярусной архитектурой, которая включет в себя: | ||
|
||
- **Презентационного уровня** - графический интерфейс представленный пользователю (браузеру), включая javascript сценарии, стили и ресурсы. | ||
1. **Презентационный уровень** - графический интерфейс, представленный пользователю (браузеру), включая JavaScript сценарии, стили и ресурсы. | ||
|
||
- **Уровня прикладной логики** - в нашем случае это фреймворк - связующее звено, где сосредоточена большая часть бизнес-логики, работа с базой данных (Eloquent), отправка ресурсов и различная обработка. | ||
2. **Уровнь прикладной логики** - в нашем случае это фреймворк - связующее звено, где сосредоточена большая часть бизнес-логики, работа с базой данных (Eloquent), отправка ресурсов и различная обработка. | ||
|
||
- **Уровня управления ресурсами** - обеспечивает хранение данных, как правило реализуется средствами систем управления базами данных (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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Хм, давай не будем сокращать до СУБД, потому что каждый раз придёться давать ссылку, при этом если человек не знаком до этого с этим опеределением, для него есть пояснение (MySQL, PostgreSQL, Microsoft SQL Server, SQLite), ну хоть какую то БД он должен знать. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Зачем кадлый раз давай ссылку? Один раз в начале, мне кажется можно запомнить, ну ладно, верну полное название и это напишу в скобочках? Чтобы аббревиатура зрительно запомнилась, в остальном согласен |
||
|
||
|
||
![Architecture](https://orchid.software/assets/img/scheme/architecture.jpg) | ||
|
||
Сокращение времени разработки непосредственно связано с распределением обязанностей между каждым из уровней. Это особенно заметно, когда необходимо создавать вспомогательный код, в то время как, большую часть действительно полезной работы берёт на себя прикладной слой. | ||
Сокращение времени разработки, непосредственно связано с распределением обязанностей между каждым из уровней нашей архитектуры. Это особенно заметно, когда необходимо создавать вспомогательный код, в то время как, большую часть действительно полезной и практической работы берёт на себя слой (Layout). | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Полностью искажён смысл предложения. Ответственность берёт на себя именно прикладной слой, который мы описываем выше, в нашем случае это именно фрейворк laravel. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Переформулирую, да, хочу избавить от слова прикладной, оно устаревает |
||
|
||
Как различные примеры противопоставления обязанностями можно привести: | ||
- Генерация `HTML` шаблонизатором `Blade` или фреймворком `Vue`. | ||
- Использование `ORM` или хранимых процедур. | ||
- Генерация `HTML` шаблонизатором `Blade` или фреймворком `Vue`, | ||
- Использование `ORM` для упращения работы с БД или хранимых процедур. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Характеристика "для упращения работы с БД" подходит как к ORM, так и хранимых процедур. Понятное дело, что каждая перечисленная технология, улучшать свою область, но тут именно пример противопоставлений, что для одних и тех же задач могут использоваться различные технологии. Показывающий, что пользователь с пакетом так же будет их решать, только иначе. Давай вернём умерём это уточнение, так же по идеи если мы ставим запятую, то должны начать с прописной буквы, с заглавным подходят только точка и точка с запятой. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Окей |
||
|
||
В зависимости от выбора решений будут и распределены обязанности, где у каждого решения есть как плюсы так и минусы. | ||
|
||
|
@@ -55,6 +53,9 @@ Classic | Orchid | |
└── JS | | ||
``` | ||
|
||
## Как получить платформу? | ||
## Как установить платформу? | ||
|
||
Платформа свободно распространяется через интернет, [исходные коды](https://github.com/orchidsoftware/platform) и [информация о выпусках](https://github.com/orchidsoftware/platform/releases) опубликованы на GitHub. В руководстве по [установке](/ru/docs/installation/) содержатся подробные инструкции. | ||
|
||
> Для предложения улучшений этого руководства, [создайте новый issue](https://github.com/orchidsoftware/orchid.software/issues). | ||
При появлении вопросов или нахождения ошибки по документации, пожалуйста, укажите главу и сопутствующий текст, что бы указать на ошибку. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Slack канал совсем не большой и не особенно поддерживаеться, думаю имеет смысл заменить на Telegram
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ааа, ну там вроде так и было написано