Git Product home page Git Product logo

angular-doc's Introduction

AngularJS Build Status

AngularJS позволяет вам писать web приложение на стороне клиента, так как если бы у вас был умный браузер. Эта технология позволяет использовать старый добрый HTML (или HAML, Jade и иже с ними!) в качестве шаблона и расширять его синтаксис, что позволяет вам описывать компоненты приложения кратко и ясно. Так же AngularJS автоматически синхронизирует данные внутри UI(представления) с объектами в JavaScript(моделью) используя двунаправленную привязку данных. Что бы помочь вам лучше структурировать ваше приложение и сделать его простым для написания тестов, AngularJS учит браузер как делать внедрение зависимостей(dependency injection) и инверсию управления(inversion of control). Ах да, AngularJS так же помогает взаимодействовать с сервером, укрощая асинхронные вызовы с promises и deferreds, и делает клиентскую навигацию и deeplinking с hashbang уралми(urls) или HTML5 pushState пустяковым делом. И самое лучшее: Вы будете получать удовольствие от разработки!

Ссылки

Русский перевод документации:

Официальный сайт:

Дополнительный материал:

Участие в проекте

Перевод

Если вы хотите помочь с переводом то можете использовать кнопку Улучшить перевод на сайте или перейти на Gitube в папку docs/content выбрать раздел и файл, например tutorial/index.ngdoc. После того как открылся файл нажмите 'Edit', все теперь можно добавлять или улучшать перевод! Формат ngdoc - это расширенный markdown.

Все что требует перевода нужно переводить (осталось немного) ;)

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

Улучшение проекта

Если у вас есть идеи как можно улучшить проект не стесняйтесь делайте pull-request'ы, пишите в issue или на почту!

Соглашения по оформлению commit'ов и pull-request'ов

Есть некоторые соглашения по оформлению commit'ов и pull-request'ов, взятые из официального репозитория.

Сообщение должно выглядеть следующим образом

<тип>(<Что меняли>): <сообщение>

В оригинале типов восемь, для перевода добавили девятый тип translate:

  • feat (улучшение)
  • fix (исправление)
  • docs (документация)
  • style (оформление)
  • refactor (рефакторинг)
  • test (тестирование)
  • chore (рутина)
  • revert (откат изменений)
  • translate (перевод)

Пример сообщения:

translate(guide:bootstrap): Добавил перевод

Сборка документации

Сейчас еще не определились с хостингом. На данный момент используем связку travis + heroku, до этого использовали cloudbees(сейчас там сборка приостановлена но hook'и остались). Сборка начинается после добавления изменений в основной репозиторий и занимает порядка 4 - 5 минут. Любые советы, предложения приветствуются. Основная задача запускать автоматически сборку документации на сайте после изменения основного репозитория на github'е.

Если статус Build Status зеленый (passing), то последняя сборка на travis прошла успешно.

Локальная сборка документации

Необходимо склонировать себе проект и запустить сборку. Для этого необходимо сделать следующие команды:

# клонируем проект
git clone https://github.com/maksimr/angular-doc.git
# переходим в него
cd angular-doc
# устанавливаем npm пакеты
npm install
# запускаем сборку документации
grunt heroku
# запускаем сборку проекта и сервер
./init-app.sh

Благодарности

angular-doc's People

Contributors

abrons avatar alkis avatar angularjsrus avatar brent-morrow avatar brettcannon avatar bshepherdson avatar btford avatar chertov avatar dmanek avatar esprehn avatar fredsa avatar gladkih avatar igorminar avatar jamiekrug avatar krculp avatar lrlopez avatar madhead avatar maksimr avatar matsko avatar mernen avatar mhevery avatar nikolaifedorov avatar ohar avatar petebacondarwin avatar pkozlowski-opensource avatar serjis avatar sevaorlov avatar shyamseshadri avatar tamtakoe avatar vojtajina avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

angular-doc's Issues

Перевод API для различных версий AngularJS

Заметил, что https://docs.angularjs.org/api и http://angular.ru/api/ немного отличаются. В первом случае присутствует возможность выбора версии Angular'a, во втором случае данная возможность отсутствует. Также при выборе версии 1.3 на оригинальном сайте изменяются дизайн и порядок следования разделов (плюс присутствуют новые разделы, такие как ngTouch и ngMessages).

На мой взгляд поддерживать переводы для различных версий AngularJS слишком трудозатратно, поэтому предлагаю просто добавить переводы для новых компонентов (таких как ngTouch / ngMessages) в http://angular.ru/api/

Ваше мнение?

Русское сообщество в соц. сетях

Можно будет подумать о группах в соц. сетях.
Основная идея, что бы народ держался вместе, гдето в одно месте :)

Уже что-то есть в VK:
http://vk.com/angularjs

Можно будет сделать на G+. Там можно будет делиться ссылка и документами.

И после того как все устоканиться перенести этот репозиторий в отдельный проект.

Опечатка

"что колбэк error для таких ответов вызываться ((на)) будет."

Меню выбора языка в шапке

Стоит сделать выпадайку с выбором языка (примерно как тут: http://www.php.net/manual/ru/function.include.php) и поместить ее на видное место, например, в шапку рядом с поиском... пожертвовав пунктом «Главная» если что.

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

И то же самое закомитить на официальный сайт (только язык на английский поменять), а то они три года будут поддержку многоязычности рожать :-)

Перевод посредством сравнения версий

По мотивам maksimr/docs.angularjs.ru#1 (comment)

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

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

Варианты решения:

Ручной:

Смотреть на оф. репозиторий(официальный репозиторий) и ручками составить
файл где будут перечислены файлы с переводом и соответствующие
им номера коммитов с офф. репозитория.

Например:

guide:
name: bootstrap.ngdoc
hash: f24cf4b
date: 2013-05-03

Где f24cf4b58f3c2e56df188738356b21e6c898ff0c(Кнопка History)
hash файла bootstrap.ngdoc с которого мы делали
перевод.

Это позволит нам:

  1. Если узнать что файл изменился, если изменился hash (в оф. репозитории)
  2. Посмотреть diff между коммитом, с которого мы делали перевод и последним

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

Автоматический:

Надо подумать как это можно автоматизировать.
Первое что приходит на ум, положить наши файлы с переводом отдельно от английских.
Сделать hook(pre-commit) или скрипт, который будет проходить по файлам русской документации, смотреть дату изменения,
находить соответствующие им английские файлы, и собирать из этого файл соответствия.

Второе что пришло на ум, чтобы не править исходники сделать под-модулем основной репозиторий
и от туда брать hash-и файлов документации.

Минус:

  1. Надо затратить время и сделать это :)
  2. Придется править исходники сборки, так как теперь у нас будет две версии файлов, оригиналы и перевод, что может привести к конфликтам при мердже с офф репозиторием. (~)
  3. Где лучше запускать этот скрипт? Подходящее место как мне кажется для этого сборка документации на heroku,
    но тут проблема что нам придется пушить этот файл на гитхаб, что инициирует сборку на travis-е, который в свою очередь снова запустит билд на heroku %).

В общем надо подумать...

Не подключаются внешние файлы в примерах

Чего только не пробовал. Работает только <link> для CSSок. @import в CSS не работает, ссылка на внешний файл в <script> не работает, даже ссылка в deps тега <example> не инклудится.

Пример: http://www.angular.ru/cookbook/jqplugins

P.S. Может попробовать залить в движок сайта что-то типа jQuery.getScript(), если сейчас ничего подобного нет?

Создать раздел с примерами

На примере руководства разработчика сделать раздел, куда можно будет помещать статьи с живыми примерами. Например, по созданию комбобоксов или древовидных структур (http://jsfiddle.net/brendanowen/uXbn6/8/).

Проблема в том, как добавлять новые статьи по коммиту из веб-интерфейса.

Сложности с пониманием документации

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

Не полный текст в уроке 3

Страница: http://angular.ru/tutorial/step_03

"Запустите тесты командой npm run protractor, чтобы убедиться, что тесты не прошли.
Вы могли бы подумать, что нужно просто добавить в title тег следующим образом:
Однако, когда вы перезагрузите страницу, вы не увидите ожидаемого результата. ..."

Каким образом?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.