Laravel по-русски

Русское сообщество разработки на PHP-фреймворке Laravel.

Ты не вошёл. Вход тут.

#1 31.01.2014 17:03:06

Предложения по переведенной документации на сайте

Сейчас на странице документации нету ссылок на github для её поддержки и вообще очень мало информации касающейся именно перевода документации. Поэтому предлагаю в перевод добавить дополнительно отдельной самой первой или самой последней главой/раздело страничку с информацией о команде переводчиков, где располагается git c её репо, как вообще осуществляется её разработка/доработка, какой вклад может внести каждый желающий.

Еще предлагаю переводах офф. разделов посвященных её доработке и поддержке внести примечание на страничку описанную выше.

Не в сети

#2 31.01.2014 17:07:05

Re: Предложения по переведенной документации на сайте

Возможно это надо было http://laravel.ru/forum/viewtopic.php?id=217 запостить? Если так, то перенесите пожалуйста, если это возможно.

Не в сети

#3 31.01.2014 18:57:03

Re: Предложения по переведенной документации на сайте

  1. Сейчас на странице документации нету ссылок на github для её поддержки и вообще очень мало информации касающейся именно перевода документации.

Идея хорошая, но лучше вместо отдельной страницы сделать ссылку в заголовке рядом с «Перевод статьи из…», которая ведёт на github, где сразу виден README.

До этого нужно решить вопросы, поднятые здесь.

Не в сети

#4 31.01.2014 20:23:43

Re: Предложения по переведенной документации на сайте

Насчет ссылке в заголовке - я только за. Но страницу о самом документе я бы тоже сделал, т.к. это нормальная практика, перед подачей материала, ознакомить откуда вообще этот материал взялся, как он развивается и как можно внести свой вклад. Это видно и в самом Lavarel - там тоже есть отдельная статься "Contributing". Перевод офф. документации - производный продукт, к которому также должны быть свои "инструкции по применению и приготовлению". Ну и опять-таки с точки зрения сообщества в целом - это будет стимулировать других участников сообщества на внесение своего вклада.

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

Насчет того, что читателей по отношению к переводчикам намного больше - то и документацию надо делать для читателей - понял. И это действительно логично и я согласен с тем, что когда сразу в тексте указано начиная с какой версии появилась новая фишка - это действительно удобно. Но меня смущает тот факт, что тем самым мызакрываем двери для новичков желающих внести свой вклад. Хотя возможно если в readme на github более подробно описать весь процесс и логику отслеживания изменений - то этот недостаток пропадет.

Не в сети

#5 31.01.2014 20:35:18

Re: Предложения по переведенной документации на сайте

Вообще, зачем так старательно имитировать структуру официального сайта?

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

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

Сейчас в выноске указано просто "v4", в то время как на офф. сайте есть "Dev", "4.0", "4.1". На http://laravel.ru/docs/v4/ нигде не указанно с какой именно версией работает пользователь. Возможно что это вообще перевод версии 4.0 alpha, и с тех пор документация на сайте не обновлялась. А возможно что это вообще перевод Dev версии в которой описаны еще не существующие возможности. Если размещать на сайте объединенную версию, то надо указывать хотя бы на главной странице перевода документации, о том что это объединенная справка для всех подверсий 4-го релиза а также дату актуализации.

Не в сети

#6 31.01.2014 20:43:03

Re: Предложения по переведенной документации на сайте

Может кто-нибудь знает, почему офф документацию ведут в разных ветках для каждой подверсии? Или может быть кто-то может задать этот вопрос на англоязычном форуме, и заодно предложить вести объединенную ветку с указанием в какой версий появлялись новые возможности?
Мой уровень английского пока оставляет желать лучшего, но если никто не отзовется, то спрашу сам.

Не в сети

#7 31.01.2014 21:25:36

xelam
writerПисарь
Откуда: Москва
Сообщений: 50
Статей: 2

Re: Предложения по переведенной документации на сайте

likemusic пишет:

Может кто-нибудь знает, почему офф документацию ведут в разных ветках для каждой подверсии? Или может быть кто-то может задать этот вопрос на англоязычном форуме, и заодно предложить вести объединенную ветку с указанием в какой версий появлялись новые возможности?
Мой уровень английского пока оставляет желать лучшего, но если никто не отзовется, то спрашу сам.

Так все просто.
4.0 - "заморозили" и почти не обновляют, т.к. вышла версия 4.1.
4.1 - сейчас активно работают с этой веткой 
dev - версия, это версия для всего нового и для следующей версии 4.2

Не в сети

#8 31.01.2014 23:21:30

Re: Предложения по переведенной документации на сайте

Ну да, точно, все верно. Я уже сам путаться начинаю.

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

То что есть отдельные главы "Release Notes" и "Upgrade Guide" я знаю, просто интересно почему об изменениях не пишут непосредственно в ходе описания фреймворка, как это jquery и php.
Например почему тут (http://laravel.com/docs/routing#named-routes)  сразу не указать в примечании что метод Route::current() был введен только в 4.1, а до этого в версии 4.0 надо было вызывать вместо него Route::getCurrentRoute().

Не в сети

#9 31.01.2014 23:29:25

Re: Предложения по переведенной документации на сайте

В общем, насколько я сейчас понял, чтобы наиболее быстро и просто актуализировать перевод который сейчас на сайте - надо:
1) Взять за основу ветку 4.1 из англоязычной версии и делать по ней правки в wiki-версию перевода на github.
2) Затем по информации в "Release Notes" и "Upgrade Guide" внести примечания в перевод касательно различий в версиях.
3) Вынести на голосование и (дружно проголосовать smile за мои предложения касающиеся перевода документации.
4) Применить на сайте все в соответствии с принятыми предложениями.
5) Profit!!!

Не в сети

#10 01.02.2014 03:12:53

xelam
writerПисарь
Откуда: Москва
Сообщений: 50
Статей: 2

Re: Предложения по переведенной документации на сайте

likemusic пишет:

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

То что есть отдельные главы "Release Notes" и "Upgrade Guide" я знаю, просто интересно почему об изменениях не пишут непосредственно в ходе описания фреймворка, как это jquery и php.

Все изменения можно видеть в github. вот, потому и не пишут. А, если, по правде, то просто нет такой задачи у сообщества. С JQuery лучше не сравнивать. Там сообщество больше Laravel сообщества, во много, много раз.

по остальному отвечу позднее, т.к. не все так просто...

Не в сети

#11 02.02.2014 01:56:04

Re: Предложения по переведенной документации на сайте

  1. Насчет ссылке в заголовке — я только за. Но страницу о самом документе я бы тоже сделал, т.к. это нормальная практика, перед подачей материала, ознакомить откуда вообще этот материал взялся, как он развивается и как можно внести свой вклад.

В целом разумно. Хочешь написать свой вариант такой страницы?

  1. По поводу вопросов поднтятых на github — пока еще сам не пришел окончательно к чему-то конкретному, но предложенный алгоритм синхронизации мне нравится, я примерно об этом и говорил.

Ты говорил о создании разных веток для разных версий, а тот алгоритм применим к единой ветке.

  1. Но меня смущает тот факт, что тем самым мы закрываем двери для новичков желающих внести свой вклад.

То, что новичков отпугнёт единая версия — как раз не проблема. Если у нас будет 10 новичков, каждый переведёт 10 предложений — это 100 предложений с 10 различными стилями текста. Если у нас будет 2 переводчика и каждый переведёт 100 предложений (что совсем не много) — это уже 200 предложений и всего 2 стиля. Нужно нацеливаться не на тех, кто пришёл и ушёл, а на тех, кто действительно делает что-то серьёзное. Для таких людей достаточно описать процесс работы в README.

А для читающих, как я уже говорил, эта схема даже лучше.

  1. Если размещать на сайте объединенную версию, то надо указывать хотя бы на главной странице перевода документации, о том что это объединенная справка для всех подверсий 4-го релиза а также дату актуализации.

Совершенно верно.

  1. То что есть отдельные главы «Release Notes» и «Upgrade Guide» я знаю, просто интересно почему об изменениях не пишут непосредственно в ходе описания фреймворка, как это jquery и php.

Вероятно, просто автор начал эту традицию и так и пошло. Вообще говоря, деление по версиям я видел всего на нескольких сайтах, среди которых Oracle и MySQL. Даже у крупных сайтах вроде MSDN изменения по версиям отражены прямо в тексте документации (например, такая-то возможность появилась в Windows Server 2008). На мой взгляд это удобно.

  1. 2) Затем по информации в «Release Notes» и «Upgrade Guide» внести примечания в перевод касательно различий в версиях.

По идее эти заметки как раз должны отражать то, что будет в diff между 4.0 и 4.1. Кстати, кто-нибудь смотрел — документация 4.1 это форк 4.0 или её действительно заново писали? В последнем сомневаюсь. Если это форк достаточно просто взять diff.

  1. 3) Вынести на голосование и (дружно проголосовать ☺ за мои предложения касающиеся перевода документации.

Перичисли их ещё раз в одном месте, а то не понятно, какие из них до сих пор актуальны, какие нет.

  1. А, если, по правде, то просто нет такой задачи у сообщества.

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

Не в сети

#12 02.02.2014 03:41:47

Re: Предложения по переведенной документации на сайте

Proger_XP пишет:

Хочешь написать свой вариант такой страницы?

Думаю набросаю по аналогии с английской версией. Там пару предложений всего-то. Потом вместе допилим.

Proger_XP пишет:

Ты говорил о создании разных веток для разных версий, а тот алгоритм применим к единой ветке.

Да, т.к. изначально и думал делать перевод по аналогии с офф. версией в разных ветках.

Proger_XP пишет:

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

Согласен.

Не в сети

#13 02.02.2014 03:53:06

Re: Предложения по переведенной документации на сайте

Proger_XP пишет:

Кстати, кто-нибудь смотрел — документация 4.1 это форк 4.0 или её действительно заново писали?

Насколько я понял понял по https://github.com/laravel/docs/network - да.
19 декабря от master ветки отпочковалась ветка 4.0
12 декабря ветка 4.1

1587 вставок, 564 удалений, 7442 всего строк.
Т.е. получается получается что 20...30% только изменилось, что меня в принципе радует.

Дифф:
http://pastebin.com/iWD0K5GH - текст.
http://i33.fastpic.ru/big/2014/0202/ee/ … 10d6ee.png -картинка

Не в сети

#14 02.02.2014 04:29:51

Re: Предложения по переведенной документации на сайте

Proger_XP пишет:

Перечисли их ещё раз в одном месте, а то не понятно, какие из них до сих пор актуальны, какие нет.

Предложения по документации

- Добавить отдельную главу с информацией о переводе
  - о тех кто переводил
  - возможно о русскоязычном сообществе laravel в целом
  - ссылка на git-репо
  - какой вклад может внести каждый желающий
  - возможно скопировать из readme в git, как вообще осуществляется разработка/доработка перевода
- В переводах офф. разделов посвященных её доработке и поддержке внести примечание со ссылкой на страничку описанную выше.
-  Указать на главной странице перевода документации, о том, что это объединенная справка для всех подверсий 4-го релиза а также дату актуализации.

Еще было предложение делать ветки аналогичные офф. репо - но на данный момент мне кажется, что действительно лучше делать объединенную версию.
Еще как вариант, можно было бы вести ветки как на офф. + своя объединенная ветка, но это скорее всего еще больше все усложнит в итоге.

Не в сети

Подвал раздела