|
1 |
| -# Русскоязычное сообщество Laravel |
| 1 | +# Веб-сайт русскоязычного сообщества Laravel |
2 | 2 |
|
3 |
| -Добро пожаловать в репозиторий русскоязычного сообщества Laravel! Здесь вы найдете полезные ресурсы, документацию и |
4 |
| -возможность общаться с другими разработчиками. |
| 3 | +Этот репозиторий содержит основной код веб-сайта [laravel.su](https://laravel.su). |
5 | 4 |
|
6 |
| -# Список задач |
| 5 | +Здесь вы найдете разделы, предлагающие различные типы материалов: |
7 | 6 |
|
8 |
| -## Документация (Работа с кодом) |
9 |
| - |
10 |
| -- [ ] Корректное отображение кода - Убедиться, что код в документации отображается правильно, с соблюдением форматирования, подсветкой синтаксиса |
11 |
| -- [x] Корректное отображение таблиц - Убедиться, что таблицы в документации отображаются так, чтобы данные были читаемыми и оформлены правильно, с правильным выравниванием содержимого ячеек. |
12 |
| -- [x] Корректное отображение коллекций (столбцов) - Проверить, что коллекции (например, списки или словари) в документации правильно отображаются, особенно когда имеются вложенные структуры данных. |
13 |
| -- [x] Корректное отображение цитат - Убедиться, что цитаты в документации выделяются и форматируются соответствующим образом для читаемости и понятности. |
14 |
| -- [x] Корректное отображение предупреждений - Проверить, что предупреждения в документации явно выделяются, чтобы пользователи могли обратить на них внимание. |
15 |
| -- [x] Типограф - Применить правила типографики к тексту документации с целью улучшения его читаемости, например, автоматическое исправление ошибок в расстановке кавычек, дефисов и других знаков препинания. |
16 |
| -- [x] Команда для загрузки документов из git - Создать команду, которая будет позволять загружать документацию напрямую из системы контроля версий Git, чтобы всегда иметь актуальную версию документации доступной для пользователей. |
17 |
| -- [ ] Поиск по документации - Реализовать функциональность поиска в документации, чтобы пользователи могли быстро находить нужную информацию по ключевым словам или фразам. |
18 |
| -- [ ] Проверка прошлых версий на работоспособность - Регулярно тестировать документацию на старых версиях продукта, чтобы убедиться, что все примеры и инструкции все еще актуальны и работоспособны. |
19 |
| -- [x] Переключение версий - Предоставить возможность пользователям выбирать нужную версию документации |
20 |
| -- [ ] Обноавить инструкцию для системы переводов, что бы её было легко понять |
21 |
| -- [x] Записывать последний доступный хэш коммита |
22 |
| -- [x] Дружелюбно показывать если документация отстаёт от оригинала и на сколько сильно |
23 |
| -- [x] Форматирование отступов, что бы последнего не было никогда. |
24 |
| - |
25 |
| -## Документация (Работа с текстом) |
26 |
| - |
27 |
| -- [x] Сделать PR в репозиторий, который бы позволял использовать YAML формат в документах |
28 |
| -- [ ] Решить, нужно ли показывать страницы которых нет совсем |
29 |
| -- [x] Сделать перевод актуальной версии laravel |
30 |
| - |
31 |
| -## Профиль |
32 |
| - |
33 |
| -- [x] Вход через GitHub, что бы брать только активнвую аудиторию и сьэкономить на страницах и рассылки email |
34 |
| -- [x] Выход пользователя |
35 |
| -- [x] Ачивки пользователя - вознагрождать пользователя, за то что он состоит в организации laravel, за написание статей или комментариев или пакетов. |
36 |
| -- [x] Добавление информации о себе и дать возможность изменять имя, так как оно скорее всего будет на английском в github |
37 |
| - |
38 |
| -## Публикации |
39 |
| - |
40 |
| -- [x] Возможность пользователю делать публикации |
41 |
| -- [x] Markdown редактор (Пусть пользователь сразу привыкает к тому, что ему придётся иметь дело именно с markdown) |
42 |
| -- [ ] Маркер, для того что бы пользователь определился сам, как будет выглядеть короткая версия поста, либо сделать это автоматически |
43 |
| -- [x] Генерация изображений для социальных сетей и ссылок, где бы заголовок отображался на картинке красиво |
44 |
| -- [ ] Предпросмотр того как статья будет выглядеть ещё до публикации |
45 |
| -- [x] Теги публикации, лучше всего из списка Enum и до 1/2/3 |
46 |
| -- [ ] Рейтинг +1 / -1 где пользователь может высказывать понравилась ли ему публикация |
47 |
| -- [x] Система коментариев с поддержкой (Не большой?) вложенности |
48 |
| -- [ ] Рейтинг у комментария |
49 |
| -- [x] Меншены в комментариях? |
50 |
| -- [ ] Возможность загрузки изображений через редактор и их эффективное удаление/ресайз |
51 |
| -- [x] Блок с самыми полулярными публикациями |
52 |
| -- [x] Push/Site уведомления о новых комментариях или упоминаний |
53 |
| - |
54 |
| -## Как использовать этот репозиторий |
55 |
| - |
56 |
| -Мы постоянно стараемся расширять и улучшать содержимое этого репозитория, чтобы обеспечить вас всей необходимой |
57 |
| -информацией. Здесь вы найдете разделы, предлагающие различные типы материалов: |
58 |
| - |
59 |
| -- **[Документация](https://github.com/laravelrus/docs)**: Русскоязычная документация Laravel, которая поможет вам лучше |
60 |
| - понять фреймворк и его функциональные возможности. |
61 |
| - |
62 |
| -## Как внести свой вклад |
63 |
| - |
64 |
| -Мы всегда рады новым участникам и их идеям! Если вы хотите внести свой вклад в развитие репозитория, вы можете сделать |
65 |
| -следующее: |
66 |
| - |
67 |
| -- Предложить добавление новых материалов или улучшение существующих. |
68 |
| -- Создать запрос на добавление примера кода или статьи. |
69 |
| -- Добавить ссылки на полезные ресурсы или пакеты. |
| 7 | +- **[Документация](https://github.com/laravelrus/docs)**: Репозиторий с переводом документации. |
70 | 8 |
|
71 | 9 | ### Установка
|
72 | 10 |
|
73 |
| -Для использования данного проекта обязательно требуется настройка HTTPS-протокола, а также конфигурирование доступов для взаимодействия с GitHub API. Для этого необходимо внести следующие переменные в файл `.env` вашего проекта: |
| 11 | +Для использования данного проекта обязательно требуется настройка HTTPS-протокола, а также конфигурирование доступов для |
| 12 | +взаимодействия с GitHub API. Для этого необходимо внести следующие переменные в файл `.env` вашего проекта: |
74 | 13 |
|
75 | 14 | ```bash
|
76 | 15 | # Здесь должен быть ваш персональный токен доступа на GitHub
|
@@ -106,22 +45,6 @@ php artisan app:update-packages
|
106 | 45 |
|
107 | 46 | Убедитесь, что перед использованием команд `artisan` вы находитесь в корневой директории вашего проекта.
|
108 | 47 |
|
109 |
| -## Связаться с нами |
110 |
| - |
111 |
| -Мы всегда открыты для обратной связи, вопросов и предложений. Вы можете связаться с нами через телеграм: |
112 |
| - |
113 |
| -- Илья Чубаров: @agoalofalife |
114 |
| -- Александр Черняев: @tabuna |
115 |
| - |
116 |
| - |
117 |
| - |
118 |
| -Напиши раздел документации с плохими и хорошими примерами для Laravel на тему |
119 |
| -"Никаких сокращений". |
120 |
| -Где уделяется внимание: правильному выбору имён для переменных/классов/методов и т.п. |
| 48 | +## Лицензия |
121 | 49 |
|
122 |
| -Придумывайте имена, которые ясно описывают объекты или действия. |
123 |
| -Делайте так, чтобы имена были различимы и не путались между собой. |
124 |
| -Используйте такие имена, которые можно легко произнести. |
125 |
| -Выбирайте имена, по которым легко искать в коде. |
126 |
| -Вместо использования «волшебных» чисел, создавайте для них именованные константы. |
127 |
| -Не добавляйте лишних приставок или информацию о типе к именам. |
| 50 | +Этот проект распространяется под лицензией [CC BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/deed.ru). |
0 commit comments