265

Полная и свежая документация по Django Rest Framework

Серия Мой OpenSource
Полная и свежая документация по Django Rest Framework

Собственно, всем желающим: https://github.com/ilyachch/django-rest-framework-rusdoc

Еще в 2017 году я задумал сделать перевод документации по DRF. И начинал с перевода вручную. После перевода Quickstart понял, что так дело не пойдет. Начал переводить с помощью переводчиков с редактурой. Стало чуть быстрее.

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

Сейчас проект поддерживается в максимально актуальном состоянии:

  • каждую неделю по крону выкачивается документация оригинала и сравниваются хэши файлов у меня и в источнике (можно посмотреть код workflow гитхаб экшенов)

  • в случае наличия изменений, автоматом создается ветка и pull-request, которые я обрабатываю за пару дней (по мере наличия времени)

  • все изменения проходят мою ручную редактуру

Если кому-то будет полезно, буду рад.

Правила сообщества

Публиковать могут пользователи с любым рейтингом. Однако!


Приветствуется:

• уважение к читателям и авторам

• конструктивность комментариев

• простота и информативность повествования

• тег python2 или python3, если актуально

• код публиковать в виде цитаты, либо ссылкой на специализированный сайт


Не рекомендуется:

• допускать оскорбления и провокации

• распространять вредоносное ПО

• просить решить вашу полноценную задачу за вас

• нарушать правила Пикабу

4
DELETED
Автор поста оценил этот комментарий

Очень полезная для новичков штука, как по мне. То-бишь, конечно, рано или поздно любому кодеру придется начать читать английскую документацию, но, чтобы сделать первые шаги - русская документация очень будет полезна.

раскрыть ветку (1)
2
Автор поста оценил этот комментарий
Безусловно, мидлы и выше могут прожить без русской документации. Но, вспоминая, как я разбирался с разными фреймворками - там случается двойная когнитивная нагрузка. Мало того, что ты разбираешься в новом для тебя материале, так ещё и на неродном языке.
1
Автор поста оценил этот комментарий

Хорошее дело делаете) Хотя не очень уверен, что прежде, чем более-менее изучить английский, стоит начинать кодить: ну камон, переменные, методы, классы - всё надо называть по-английски. Комменты и коммит месседжи - тоже желательно. Как по мне, чем написать проект, используя имена типа "schet", "Kniga", "sohran" и т. п., лучше ничего не писать. А может, я слишком категоричен, ведь многим нужно чтобы РАБОТАЛО СЕЙЧАС, и интерпретатору пофиг на имена.


В любом случае это не умаляет важности вашего труда, уверен, многие оценят))

раскрыть ветку (1)
1
Автор поста оценил этот комментарий
На самом деле, полностью согласен, но, как писал выше, для некоторых людей может быть достаточно тяжело изучать новый материал на неродном языке. Из-за двойной когнитивной нагрузки.
Поэтому я не позиционирую это как замену, скорее, как помощь. А внимание актуальности я уделил потому, что хуже, чем отсутствие документации может быть только неверная документация:)
В целом, это проект, которого мне не хватало, когда я заходил в разработку:) хоть сейчас я и читаю только англ источники.
а про переменные транслитом - это прям да:)))
0
Автор поста оценил этот комментарий

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

раскрыть ветку (1)
0
Автор поста оценил этот комментарий
Ну с фреймворками так всегда:)
шаг влево, шаг вправо - начинается боль:)

Темы

Политика

Теги

Популярные авторы

Сообщества

18+

Теги

Популярные авторы

Сообщества

Игры

Теги

Популярные авторы

Сообщества

Юмор

Теги

Популярные авторы

Сообщества

Отношения

Теги

Популярные авторы

Сообщества

Здоровье

Теги

Популярные авторы

Сообщества

Путешествия

Теги

Популярные авторы

Сообщества

Спорт

Теги

Популярные авторы

Сообщества

Хобби

Теги

Популярные авторы

Сообщества

Сервис

Теги

Популярные авторы

Сообщества

Природа

Теги

Популярные авторы

Сообщества

Бизнес

Теги

Популярные авторы

Сообщества

Транспорт

Теги

Популярные авторы

Сообщества

Общение

Теги

Популярные авторы

Сообщества

Юриспруденция

Теги

Популярные авторы

Сообщества

Наука

Теги

Популярные авторы

Сообщества

IT

Теги

Популярные авторы

Сообщества

Животные

Теги

Популярные авторы

Сообщества

Кино и сериалы

Теги

Популярные авторы

Сообщества

Экономика

Теги

Популярные авторы

Сообщества

Кулинария

Теги

Популярные авторы

Сообщества

История

Теги

Популярные авторы

Сообщества

Недвижимость и ремонт

Теги

Популярные авторы

Сообщества