From d0c96955783845b1244d9fc34892208fc51160c1 Mon Sep 17 00:00:00 2001 From: Ivan Istomin Date: Fri, 15 Nov 2019 13:57:28 +0300 Subject: [PATCH 1/2] Fix errata --- source/en/docs/field.md | 2 +- source/en/docs/quickstart-files.md | 3 ++- source/en/docs/quickstart.md | 2 +- source/ru/docs/attachments.md | 7 +++---- source/ru/docs/code-of-conduct.md | 13 +++++-------- source/ru/docs/field.md | 2 +- source/ru/docs/quickstart-files.md | 3 ++- 7 files changed, 15 insertions(+), 17 deletions(-) diff --git a/source/en/docs/field.md b/source/en/docs/field.md index dd4b7faff..ac9862585 100644 --- a/source/en/docs/field.md +++ b/source/en/docs/field.md @@ -130,7 +130,7 @@ TinyMCE::make('html') To display the top pane and a menu in the editor, where the functions of full-screen mode and viewing html code are available, you need to set the attribute `theme ('modern')`. -### HTML editor Qill +### HTML editor Quill Example: ```php diff --git a/source/en/docs/quickstart-files.md b/source/en/docs/quickstart-files.md index 0001aa178..52408020d 100644 --- a/source/en/docs/quickstart-files.md +++ b/source/en/docs/quickstart-files.md @@ -207,7 +207,8 @@ But also describe the synchronization of dependent records by relations in our s ```php public function createOrUpdate(Post $post, Request $request) { - $post->fill($request->get('post'))->save(); + $post->fill($request->get('post')->except('attachment')) + ->save(); $post->attachment()->syncWithoutDetaching( $request->input('post.attachment', []) diff --git a/source/en/docs/quickstart.md b/source/en/docs/quickstart.md index 942375fd5..5bd5f0781 100644 --- a/source/en/docs/quickstart.md +++ b/source/en/docs/quickstart.md @@ -132,7 +132,7 @@ public function layout(): array ->placeholder('Insert text here ...') ->help('Add the content for the message that you would like to send.') - ])->with(70) + ]) ]; } ``` diff --git a/source/ru/docs/attachments.md b/source/ru/docs/attachments.md index a37ec742f..627edcba0 100644 --- a/source/ru/docs/attachments.md +++ b/source/ru/docs/attachments.md @@ -5,7 +5,7 @@ extends: _layouts.documentation.ru section: main --- -Файлы различных форматов и расширений относящиеся к записи являются вложениями +Файлы различных форматов и расширений относящиеся к записи являются вложениями. Вложения могут быть прикреплены к любой модели посредством связей, для этого необходимо добавить трейт: @@ -65,10 +65,9 @@ $image->url(); позволяя эффективно использовать ресурсы. Файл будет удалёт только тогда, когда все ссылки будут уничтожены. -## Подписка на загрузку +## Подписка на событие загрузки -Различные варианты обработки файлов могут потребовать дополнительной обработки, например, сжатие видео, -это возможно благодаря событию, на которое можно подписаться стандартными средствами и выполнить задачу в фоне: +Различные варианты обработки файлов могут потребовать дополнительной обработки, например, сжатие видео, это возможно благодаря событию, на которое можно подписаться стандартными средствами и выполнить задачу в фоне: ```php namespace App\Providers; diff --git a/source/ru/docs/code-of-conduct.md b/source/ru/docs/code-of-conduct.md index d06074be9..d761b3102 100644 --- a/source/ru/docs/code-of-conduct.md +++ b/source/ru/docs/code-of-conduct.md @@ -6,12 +6,9 @@ section: main --- Быть вовлеченным в сообщество ORCHID — это потрясающий опыт; -вы становитесь частью чего-то большого, сотрудничаете с людьми со всего мира, -помогаете людям делать свои компьютеры восхитительными. -Но вместе с этим появляется обязательство следовать правилам, -которые обеспечивают наиболее комфортную среду для всех участников. -Следующие правила должны соблюдаться в любое время и в любом месте, -относящемуся к сообществу, будь то Slack, GitHub, ресурс сообщества ORCHID, личная беседа или что-то еще. +вы становитесь частью чего-то большого. Сотрудничаете с людьми со всего мира, +помогаете людям делать свои компьютеры восхитительными, но вместе с этим появляется обязательство следовать правилам, которые обеспечивают наиболее комфортную среду для всех участников. +Следующие правила должны соблюдаться в любое время и в любом месте, относящемуся к сообществу, будь то Slack, GitHub, ресурс сообщества ORCHID, личная беседа или что-то еще. ## Взаимоуважение @@ -21,7 +18,7 @@ section: main Сообщество ORCHID состоит из тысяч пользователей различного возраста, вероисповедания, а так же уровня зрелости. В связи с этим, вы должны отдавать себе отчет касаемо контента, который вы создаете, и комментариев, которые вы оставляете. Материалы для взрослых, ругательства, политический или религиозный материал и какой-либо иной неприемлемый контент не должны появляться в контексте ORCHID. В конечном счете модераторы ORCHID имеют решающее слово в определении неприемлемого контента. Если вы сомневаетесь, можно ли «так» писать — представьте, что перед вами аудитория, включающая детей и пожилых людей со всего света. И если вы все еще сомневаетесь, то лучше воздержаться. -Скриншоты, распространяемые внутри сообществ ORCHID, не должны содержать темы, имитирующие своим содержанием другие веб системы, а также фотографии и изображения, указывающие на определенных лиц и любой другой контент, так или иначе нарушающий наш Кодекс поведения. +Скриншоты, распространяемые внутри сообществ ORCHID, не должны содержать темы, имитирующие своим содержанием другие веб-системы, а также фотографии и изображения, указывающие на определенных лиц и любой другой контент, так или иначе нарушающий наш Кодекс поведения. ## Слухи и домыслы @@ -43,7 +40,7 @@ ORCHID создается совместными усилиями многих ## Последствия -Если вы решите не следовать вышеизложенным нормам поведения, или как-то иначе будете мешать сообществу, мы сохраняем за собой право сделать следующее: изменить или удалить любой контент, опубликованный вами; отключить или заблокировать учетную запись на сторонних веб-сайтах; отключить учетную запись в Slack; или любым другим способом воспрепятствовать вашему взаимодействию с сообществом. +Если вы решите не следовать вышеизложенным нормам поведения, или как-то иначе будете мешать сообществу, мы сохраняем за собой право сделать следующее: изменить или удалить любой контент опубликованный вами; отключить или заблокировать учетную запись на сторонних веб-сайтах; отключить учетную запись в Slack; или любым другим способом воспрепятствовать вашему взаимодействию с сообществом. ---------- diff --git a/source/ru/docs/field.md b/source/ru/docs/field.md index 8bdf85107..7869c3214 100644 --- a/source/ru/docs/field.md +++ b/source/ru/docs/field.md @@ -128,7 +128,7 @@ TinyMCE::make('html') ``` Для отображения в редакторе верхней панели и меню, в котором доступны функции полноэкранного режима и просмотр html кода, нужно установить атрибут `theme('modern')`. -### HTML редактор Qill +### HTML редактор Quill Пример записи: ```php diff --git a/source/ru/docs/quickstart-files.md b/source/ru/docs/quickstart-files.md index 5b84d211a..4b0ed248a 100644 --- a/source/ru/docs/quickstart-files.md +++ b/source/ru/docs/quickstart-files.md @@ -207,7 +207,8 @@ class Post extends Model ```php public function createOrUpdate(Post $post, Request $request) { - $post->fill($request->get('post'))->save(); + $post->fill($request->get('post')->except('attachment')) + ->save(); $post->attachment()->syncWithoutDetaching( $request->input('post.attachment', []) From 6349412f21d81295212fb911f889d2dc3d8af5fe Mon Sep 17 00:00:00 2001 From: Ivan Istomin Date: Fri, 15 Nov 2019 13:58:06 +0300 Subject: [PATCH 2/2] Starting rewrite all documentation --- source/ru/docs/index.md | 31 ++++++++++++++++--------------- 1 file changed, 16 insertions(+), 15 deletions(-) diff --git a/source/ru/docs/index.md b/source/ru/docs/index.md index 8eb72a828..6e7b22f8e 100644 --- a/source/ru/docs/index.md +++ b/source/ru/docs/index.md @@ -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/). -> Для предложения улучшений этого руководства, [создайте новый issue](https://github.com/orchidsoftware/orchid.software/issues). -При появлении вопросов или нахождения ошибки по документации, пожалуйста, укажите главу и сопутствующий текст, что бы указать на ошибку. -## Введение + +## Начало работы **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). ![Architecture](https://orchid.software/assets/img/scheme/architecture.jpg) -Сокращение времени разработки непосредственно связано с распределением обязанностей между каждым из уровней. Это особенно заметно, когда необходимо создавать вспомогательный код, в то время как, большую часть действительно полезной работы берёт на себя прикладной слой. +Сокращение времени разработки, непосредственно связано с распределением обязанностей между каждым из уровней нашей архитектуры. Это особенно заметно, когда необходимо создавать вспомогательный код, в то время как, большую часть действительно полезной и практической работы берёт на себя слой (Layout). Как различные примеры противопоставления обязанностями можно привести: -- Генерация `HTML` шаблонизатором `Blade` или фреймворком `Vue`. -- Использование `ORM` или хранимых процедур. +- Генерация `HTML` шаблонизатором `Blade` или фреймворком `Vue`, +- Использование `ORM` для упращения работы с БД или хранимых процедур. В зависимости от выбора решений будут и распределены обязанности, где у каждого решения есть как плюсы так и минусы. @@ -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). +При появлении вопросов или нахождения ошибки по документации, пожалуйста, укажите главу и сопутствующий текст, что бы указать на ошибку. \ No newline at end of file