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

MInor fixes and starting rewrite documentation #35

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion source/en/docs/field.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion source/en/docs/quickstart-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -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', [])
Expand Down
2 changes: 1 addition & 1 deletion source/en/docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
])
];
}
```
Expand Down
7 changes: 3 additions & 4 deletions source/ru/docs/attachments.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ extends: _layouts.documentation.ru
section: main
---

Файлы различных форматов и расширений относящиеся к записи являются вложениями
Файлы различных форматов и расширений относящиеся к записи являются вложениями.

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

Expand Down Expand Up @@ -65,10 +65,9 @@ $image->url();
позволяя эффективно использовать ресурсы. Файл будет удалёт только тогда, когда все ссылки будут уничтожены.


## Подписка на загрузку
## Подписка на событие загрузки

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

```php
namespace App\Providers;
Expand Down
13 changes: 5 additions & 8 deletions source/ru/docs/code-of-conduct.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,9 @@ section: main
---

Быть вовлеченным в сообщество ORCHID — это потрясающий опыт;
вы становитесь частью чего-то большого, сотрудничаете с людьми со всего мира,
помогаете людям делать свои компьютеры восхитительными.
Но вместе с этим появляется обязательство следовать правилам,
которые обеспечивают наиболее комфортную среду для всех участников.
Следующие правила должны соблюдаться в любое время и в любом месте,
относящемуся к сообществу, будь то Slack, GitHub, ресурс сообщества ORCHID, личная беседа или что-то еще.
вы становитесь частью чего-то большого. Сотрудничаете с людьми со всего мира,
помогаете людям делать свои компьютеры восхитительными, но вместе с этим появляется обязательство следовать правилам, которые обеспечивают наиболее комфортную среду для всех участников.
Следующие правила должны соблюдаться в любое время и в любом месте, относящемуся к сообществу, будь то Slack, GitHub, ресурс сообщества ORCHID, личная беседа или что-то еще.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Slack канал совсем не большой и не особенно поддерживаеться, думаю имеет смысл заменить на Telegram

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ааа, ну там вроде так и было написано


## Взаимоуважение

Expand All @@ -21,7 +18,7 @@ section: main

Сообщество ORCHID состоит из тысяч пользователей различного возраста, вероисповедания, а так же уровня зрелости. В связи с этим, вы должны отдавать себе отчет касаемо контента, который вы создаете, и комментариев, которые вы оставляете. Материалы для взрослых, ругательства, политический или религиозный материал и какой-либо иной неприемлемый контент не должны появляться в контексте ORCHID. В конечном счете модераторы ORCHID имеют решающее слово в определении неприемлемого контента. Если вы сомневаетесь, можно ли «так» писать — представьте, что перед вами аудитория, включающая детей и пожилых людей со всего света. И если вы все еще сомневаетесь, то лучше воздержаться.

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

## Слухи и домыслы

Expand All @@ -43,7 +40,7 @@ ORCHID создается совместными усилиями многих

## Последствия

Если вы решите не следовать вышеизложенным нормам поведения, или как-то иначе будете мешать сообществу, мы сохраняем за собой право сделать следующее: изменить или удалить любой контент, опубликованный вами; отключить или заблокировать учетную запись на сторонних веб-сайтах; отключить учетную запись в Slack; или любым другим способом воспрепятствовать вашему взаимодействию с сообществом.
Если вы решите не следовать вышеизложенным нормам поведения, или как-то иначе будете мешать сообществу, мы сохраняем за собой право сделать следующее: изменить или удалить любой контент опубликованный вами; отключить или заблокировать учетную запись на сторонних веб-сайтах; отключить учетную запись в Slack; или любым другим способом воспрепятствовать вашему взаимодействию с сообществом.

----------

Expand Down
2 changes: 1 addition & 1 deletion source/ru/docs/field.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ TinyMCE::make('html')
```
Для отображения в редакторе верхней панели и меню, в котором доступны функции полноэкранного режима и просмотр html кода, нужно установить атрибут `theme('modern')`.

### HTML редактор Qill
### HTML редактор Quill

Пример записи:
```php
Expand Down
31 changes: 16 additions & 15 deletions source/ru/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Как по мне, странно, что Laravel дважды упоминаеться в одном обзаце при этом с разными ссылками.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ну, не знаю просто насколько ты против убрать русский устаревший перевод. У лараверя хороший английский с документации

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

У меня была договорённость с laravel.su, что они дают ссылку на меня, а я на них.
Пока мы оба исполняем эти условия, мне не хотелось их нарушать.


> Для предложения улучшений этого руководства, [создайте новый issue](https://github.com/orchidsoftware/orchid.software/issues).
При появлении вопросов или нахождения ошибки по документации, пожалуйста, укажите главу и сопутствующий текст, что бы указать на ошибку.


## Введение

## Начало работы
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Начало работы ассоциируеться с тем, что мне уже пора расчихлять IDE и начинать, что-либо делать.
Но тут лишь поясняеться, что делает пакет и за счёт чего обеспечиваеться "эффективная" разработка.

Может быть имеет смысл вообще перенести абзацы и не делить на разделы. Просто Введение и там уже сначало пояснение "ORCHID - это пакет для создания приложений", а уже затем предупреждение, что руководство не поясняет фреймворк?

Copy link
Contributor Author

Choose a reason for hiding this comment

The 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).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Хм, давай не будем сокращать до СУБД, потому что каждый раз придёться давать ссылку, при этом если человек не знаком до этого с этим опеределением, для него есть пояснение (MySQL, PostgreSQL, Microsoft SQL Server, SQLite), ну хоть какую то БД он должен знать.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Зачем кадлый раз давай ссылку? Один раз в начале, мне кажется можно запомнить, ну ладно, верну полное название и это напишу в скобочках? Чтобы аббревиатура зрительно запомнилась, в остальном согласен



![Architecture](https://orchid.software/assets/img/scheme/architecture.jpg)

Сокращение времени разработки непосредственно связано с распределением обязанностей между каждым из уровней. Это особенно заметно, когда необходимо создавать вспомогательный код, в то время как, большую часть действительно полезной работы берёт на себя прикладной слой.
Сокращение времени разработки, непосредственно связано с распределением обязанностей между каждым из уровней нашей архитектуры. Это особенно заметно, когда необходимо создавать вспомогательный код, в то время как, большую часть действительно полезной и практической работы берёт на себя слой (Layout).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Полностью искажён смысл предложения. Ответственность берёт на себя именно прикладной слой, который мы описываем выше, в нашем случае это именно фрейворк laravel.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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


Как различные примеры противопоставления обязанностями можно привести:
- Генерация `HTML` шаблонизатором `Blade` или фреймворком `Vue`.
- Использование `ORM` или хранимых процедур.
- Генерация `HTML` шаблонизатором `Blade` или фреймворком `Vue`,
- Использование `ORM` для упращения работы с БД или хранимых процедур.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Характеристика "для упращения работы с БД" подходит как к ORM, так и хранимых процедур.

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

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

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Окей


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

Expand All @@ -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).
При появлении вопросов или нахождения ошибки по документации, пожалуйста, укажите главу и сопутствующий текст, что бы указать на ошибку.
3 changes: 2 additions & 1 deletion source/ru/docs/quickstart-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -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', [])
Expand Down