forum.bitel.ru :: Просмотр темы - Ошибки/опечатки/неточности в существующей документации (CRM)

forum.bitel.ru http://forum.bitel.ru/

Ошибки/опечатки/неточности в существующей документации (CRM) http://forum.bitel.ru/viewtopic.php?f=1&t=4435	Страница 3 из 11

Автор:	Администратор [ 25 янв 2008, 20:35 ]
Заголовок сообщения:
Исправлены все замечания, глава о настройке NASов, переписана более подробно. Прошу снова дать общую оценку разделу DialUP: что плохо описано, где что непонятно.

Автор:	vadim s. sabinich [ 30 янв 2008, 21:48 ]
Заголовок сообщения:	http://bgbilling.ru/v4.4/doc/ch07s09.html
да-да. Я продолжаю идти по главе. Не было времени заняться раньше. 1. Как-то куце выглядить такое Код: 9. Настройка RADIUS сервера для DialUp 9.1. Установка BGRadiusDialup на LINUX платформу Может между 9 и 9.1 кратенько описать как работает именно ваш радиус? Историю его создания? Почему решили написать свой и не стали использовать какой-нить FreeRadius и проч. 2. Код: 1) Извлеките BGRadiusDialup из архива и скопируйте в каталог /usr/local Корявенько. "Для установки следует извлечь BGRadius из архива и скопировать в.." Кстати, а почему каталоги или папки? Почему не директории? 3. Код: соответствии с __фукнциональным__ назначением модуля, 4. Код: рверов __BGBilling а__, можно 5. Код: 12) Произведите настройку radius.properties и запустите RADIUS сервер (см. далее) Может проще "Настройте" или "отредактируйте файл под свои нужды"? 6. Код: 4) Установите переменную окружения BGRAD_HOME_DIALUP=C:\BGRadiusDialup. Как устанавливать переменные окружения можете посмотреть в инструкции по установке сервера + клиента биллинга. может лучше ссылочку перекрестную сделать? И в остальных "см.ниже" и т.п 7. Код: С работающего RADIUS сервера возможно получение __с сервера__ списка соединений и статуса. 8. Код: Для UNIX систем уже создан набор скриптов (radius_ps.sh, radius_status.sh ), простой запуск которых даст нужный результат. Список сое А где продолжение? =)

Автор:	Gankov [ 06 фев 2008, 13:56 ]
Заголовок сообщения:
Страница http://bgbilling.ru/v4.4/doc/ch07s30s02.html цитата: wifi.agent.radius.live.time - время жизни клиента с точки зрения радиуса. wifi.agent.client.live.time - время жизни агента с точки зрения WiFi агента. Может быть во второй строчьке тоже имеется ввиду "время жизни клиента" (вообще фраза хорошо звучит) цитата 2:billing.server.password.remind - показывать ли сслыку на страницу напоминания пароля(1- показывать; 0 - не показывать, стоит по умолчанию ).Если этот флаг поднят в 1, то в конфигурации модуля должен быть указан параметр mail.contract.param.code(смотрите главу "Web-интрерфейс" этого модуля). Думаю "смотрите главу" надо сделать с со ссылкой

Автор:	snark [ 12 фев 2008, 21:51 ]
Заголовок сообщения:
Добавлю свои 5 копеек Глава 7. Модуль DialUp -> 7. Настройка модуля Цитата: В конфигурации модуля установите: Не удобнее ли сделать некую дефолтную конфигурацию которая ставилась бы вместе с модулем? Кстати, приведенная в этом параграфе конфигурация подойдет для v4.3? А то разница там небольшая, но кое какие добавления есть ... 9.1. Установка BGRadiusDialup на LINUX платформу Цитата: 5) Окройте для редактирования файл radius.sh и пропишите в нем путь к JAVA машине, например так: Код: ... cd ${0%${0##/}}. JAVA_HOME=/opt/java/jdk16 if [ -z "$JAVA_HOME" ]; then echo "The JAVA_HOME environment variable is not defined" echo "This environment variable is needed to run this program" exit 1 fi ... Я бы предложил как тут (RADIUS) так и в ядре сделать гораздо проще, а именно: Создаем файл, допустим java_home.conf в котором пишем: Код:* # set JAVA_HOME variable JAVA_HOME='/usr/local/jdk1.6.0/jre' Затем во всех файлах где необходимо указать данную переменную достаточно написать: Код: cd ${0%${0##/}}. . ./java_home.conf if [ -z "$JAVA_HOME" ]; then echo "The JAVA_HOME environment variable is not defined" echo "This environment variable is needed to run this program" exit 1 fi Обратите внимание на 1-ю точку в строке: Цитата:* . ./java_home.conf Именно она предписывает инклюдить файл! 2-я точка вкупе со слешем говорит о том что файл находится в текущей директории! Так же очень прошу обратить внимание на то что echo равно как и любые тексты все же лучше писать через 4 (четыре) пробела, т.к. если у человека правильно, в соответствии с многочисленными coding standarts, настроен редактор для него это будет означать табуляцию Радуемся жизни т.к. нужные переменные достаточно указать всего 1 раз и потом они используются. То же самое можно отнести и к указанию пути к, например, nice ну или любым другим системным бинарикам не лежащим в области JAVA_HOME. Цитата: 6) Проверьте .sh файлы на наличие символов ^M, если символы присутсвуют их можно удалить вручную либо воспользоваться утилитой: Код: dos2unix .sh Господа, ставить какой то доп. софт - это не unix-way Все же гораздо лучше делать это встроенными средствами, например так: Код:* cp file_name file_name.tmp && cat file_name.tmp \| tr -d '\r' > file_name && rm -f file_name.tmp на выходе получаем файл с нужными нам переводами строк. 9.4. Управление BGRadiusDialup Цитата: Для UNIX систем уже создан набор скриптов (radius_ps.sh, radius_status.sh ), простой запуск которых даст нужный результат. Список сое А дальше что?

Автор:	Администратор [ 15 фев 2008, 14:04 ]
Заголовок сообщения:
Цитата: Глава 7. Модуль DialUp -> 7. Настройка модуля Цитата: В конфигурации модуля установите: Не удобнее ли сделать некую дефолтную конфигурацию которая ставилась бы вместе с модулем? Кстати, приведенная в этом параграфе конфигурация подойдет для v4.3? А то разница там небольшая, но кое какие добавления есть ... Большей частью подойдет. По поводу дефолтной конфигурации не согласен, т.к. скопировать с сайта сложность не большая, а попутно человек прочитает комментарии к параметрам. Цитата: 9.1. Установка BGRadiusDialup на LINUX платформу Цитата: 5) Окройте для редактирования файл radius.sh и пропишите в нем путь к JAVA машине, например так: Код: ... cd ${0%${0##/}}. JAVA_HOME=/opt/java/jdk16 if [ -z "$JAVA_HOME" ]; then echo "The JAVA_HOME environment variable is not defined" echo "This environment variable is needed to run this program" exit 1 fi ... Я бы предложил как тут (RADIUS) так и в ядре сделать гораздо проще, а именно:[list=1][]Создаем файл, допустим java_home.conf в котором пишем: Код: # set JAVA_HOME variable JAVA_HOME='/usr/local/jdk1.6.0/jre' []Затем во всех файлах где необходимо указать данную переменную достаточно написать: Код:* cd ${0%${0##/}}. . ./java_home.conf if [ -z "$JAVA_HOME" ]; then echo "The JAVA_HOME environment variable is not defined" echo "This environment variable is needed to run this program" exit 1 fi Обратите внимание на 1-ю точку в строке: Цитата:* . ./java_home.conf Именно она предписывает инклюдить файл! 2-я точка вкупе со слешем говорит о том что файл находится в текущей директории! Спасибо за пример. Мы подумаем о целесообразности использования такой схемы. Но на мой взгяд, она все лишь усложняет. Скрипты - на то и скрипты, что каждый может поправить их на свой вкус. Можно JAVA_HOME устанавливать вообще как системную переменную. Где-нибудь при запуске ОС сделать export и все. Цитата: Так же очень прошу обратить внимание на то что echo равно как и любые тексты все же лучше писать через 4 (четыре) пробела, т.к. если у человека правильно, в соответствии с многочисленными coding standarts, настроен редактор для него это будет означать табуляцию Внимание обратили... А почему не писать через таб? И вообще что дает, то что для редактора четыре пробела означает табуляцию? Выравнивание? Цитата: Господа, ставить какой то доп. софт - это не unix-way Все же гораздо лучше делать это встроенными средствами, например так: Код: cp file_name file_name.tmp && cat file_name.tmp \| tr -d '\r' > file_name && rm -f file_name.tmp на выходе получаем файл с нужными нам переводами строк. Мы постараемся сделать к 4.4 версии просто 2 скрипта: prepare_to_linux.sh prepare_to_win.bat задача каждого будет удалить скрипты конкурирующей платформы и проставить права + удалить \r для linux. Чтоб проще было. Цитата: А дальше что? А что должно быть дальше?

Автор:	snark [ 15 фев 2008, 17:51 ]
Заголовок сообщения:
Администратор писал(а): По поводу дефолтной конфигурации не согласен, т.к. скопировать с сайта сложность не большая, а попутно человек прочитает комментарии к параметрам. IMHO, все же логичнее когда каждый модуль сразу имеет свою, пусть даже идеинтичную тому что на сайте, конфигурацию. Человеку останется лишь разобраться в тех или иных параметрах и при необходимости добавить нужные строки. Ведь с той же Java идут примеры Администратор писал(а): Спасибо за пример. Мы подумаем о целесообразности использования такой схемы. Но на мой взгяд, она все лишь усложняет. Да незачто в общем то ... Дело в том что предложенная мной схема позволяет указать JAVA_HOME ровно в одном месте и затем вся конструкция биллинга будет работать с этой переменной. Когда человек прочтет что-то в духе "BGBilling более не поддерживает JAVA с версией менее 1.6.0."(с) то ему надо будет обновить свою версию JRE/JDK и при обновлении Java достаточно будет подправить конфиг только один раз и не думать "черт, где же еще надо вписать эту переменную то, а?". Администратор писал(а): Скрипты - на то и скрипты, что каждый может поправить их на свой вкус. Я не склонен думать что Ваши скрипты кто-либо будет когда-либо менять Администратор писал(а): Можно JAVA_HOME устанавливать вообще как системную переменную. Где-нибудь при запуске ОС сделать export и все. Хоть export, хоть setenv ... IMHO устанавливать JAVA_HOME при старте ОС не совсем верно, т.к. возможно, у кого-то работает N-е програмное обеспечение которому просто необходима Java какой-то строго определенной версии и никакая другая Java не подходит. Администратор писал(а): А почему не писать через таб? И вообще что дает, то что для редактора четыре пробела означает табуляцию? Выравнивание? ТАВ-ы в разных редакторах/ОС имеют разные размеры, а 4 пробела - это всегда 4 пробела и выглядят они всегда как 4 пробела, т.е. да, конечно выравнивание, при этом, обратите внимание - выравнивание идеинтичное для всех, т.к. зачастую, все нормальные редакторы настроены на такой режим. 4 пробела это ЕМНИМС стандартный идент практически для всех языков программирования. Администратор писал(а): Цитата: А дальше что? А что должно быть дальше? Вы шутите? это я у Вас должен спросить В мануале к версии 4.4 написано: мануал v4.4 писал(а): Для UNIX систем уже создан набор скриптов (radius_ps.sh, radius_status.sh ), простой запуск которых даст нужный результат. Список сое В мануале к версии 4.3 написано: мануал v4.3 писал(а): Для UNIX систем уже создан набор скриптов ( radius_ps.sh, radius_status.sh ), простой запуск которых даст нужный результат. Статус соединения После авторизации статус соединения становится wait до прихода Start пакета. После этого статус меняется на suspend и остается таким, пока программа не убедится с помощью SNMP или по получению пакета Update что клиент действительно находится на линии. После этого статус изменяется на active и начинается обсчет соединения. Если в ходе обсчета результат SNMP проверки покажет, что соединение не активно, статус снова переходит в susend, обсчет прекращается. Разницу замечаете? Отрывки приведены от предложения: Цитата: Для UNIX систем уже создан набор скриптов (radius_ps.sh, radius_status.sh ), простой запуск которых даст нужный результат. и до конца страницы, так вот, меня интересует что идет вслед за: мануал v4.4 писал(а): Список сое в мануале к версии 4.4? Возможно там идет: Код: Список соединений и, наверное, что то еще дальше, но я могу ошибаться и поэтому еще раз спрашиваю - что идет дальше, за "Список сое"?

Автор:	stark [ 15 фев 2008, 19:26 ]
Заголовок сообщения:
snark писал(а): ТАВ-ы в разных редакторах/ОС имеют разные размеры, а 4 пробела - это всегда 4 пробела и выглядят они всегда как 4 пробела, т.е. да, конечно выравнивание, при этом, обратите внимание - выравнивание идеинтичное для всех, т.к. зачастую, все нормальные редакторы настроены на такой режим. 4 пробела это ЕМНИМС стандартный идент практически для всех языков программирования. Не соглашусь , это исключительно ваша точка зрения и спортить тут бесполезно ..обычно табуляция - это то, о чем догваривается конретная команда разработчиков ..Разработчики ядра линукс, если я не ошибаюсь , используют таб размеров в 8 пробелов и вложенность не более 3 -х. .Лично мне удобно , напрмер, когда стоит таб , а не пробелы - это текст удобнее править в тех же редакторах кода ... не пытаетесьь сказать что это стандарт - это неправда, стандартов тут нет, есть договоренности ..в вашем редакторе скорее всего можно настоить размер таба, так что не вижу проблемы

Автор:	snark [ 19 фев 2008, 15:05 ]
Заголовок сообщения:
stark писал(а): не пытаетесьь сказать что это стандарт - это неправда, стандартов тут нет, есть договоренности Не хочу показаться нетактичным, но стандарты все же есть ... Прошу прощения за оффтоп.

Автор:	stark [ 19 фев 2008, 20:39 ]
Заголовок сообщения:
snark писал(а): stark писал(а): не пытаетесьь сказать что это стандарт - это неправда, стандартов тут нет, есть договоренности Не хочу показаться нетактичным, но стандарты все же есть ... Прошу прощения за оффтоп. ну, хорошо ..только в данном соглашении ява-разработчиков , как раз ваше требование четко не детерминируется ..никто не запрещает использовать табов - "The exact construction of the indentation (spaces vs. tabs) is unspecified".

Автор:	snark [ 19 фев 2008, 22:50 ]
Заголовок сообщения:
Завязываем с оффтопом и возвращаемся к нашим баранам, т.е. к документации ... 16.8. Лимит договора, режимы договора, управление лимитом Написано: Цитата: Клиенту можно предоставить возможность самому временно понижать лимит (только в режиме Дебет). __Д__ Обратите внимание на "Д", она там просто одна одинешенька ... Там же, далее: Цитата: На закладке Управление возможно включение/выключение возможности для конкретного договора. Закладка называется "Управление лимитом", а не просто "Управление", поэтому скорее всего верно так: Цитата: На закладке Управление лимитом возможно включение/отключение возможности для конкретного договора. Слово "отключение" тут, IMHO, более логично чем "выключение" Там же далее: Цитата: На закладке Статистика отображается история понижений лимита. Господа, это не "закладка", а "вкладка", т.е. tab, поэтому думаю правильнее так: Цитата: На вкладке Статистика, закладки Управление лимитом, отображается история понижений лимита. Так Вы хотя бы путь поиска напишите, где оную статистику искать ...

Автор:	Администратор [ 20 фев 2008, 12:59 ]
Заголовок сообщения:
Переписано с учетом замечаний.

Автор:	anred [ 05 мар 2008, 21:38 ]
Заголовок сообщения:	Ошибка в howto.txt
http://www.bgbilling.ru/v4.4/download/kernel/howto.txt 7) Загрузите http://bgbilling.bitel.ru/v4.3/download ... te_4.4.zip сохраните его в папку BGBillingServer и установите инсталлятором. Наверно все же 7) Загрузите http://bgbilling.bitel.ru/v4.4/download ... te_4.4.zip сохраните его в папку BGBillingServer и установите инсталлятором

Автор:	Администратор [ 06 мар 2008, 12:48 ]
Заголовок сообщения:
Исправлено, спасибо.

Автор:	Gankov [ 20 мар 2008, 19:24 ]
Заголовок сообщения:	ошибка в документации 4.4
Страница http://bgbilling.ru/v4.4/doc/ch07s31s05.html цитата Код: Мы вам предлагаем свой вариант реализации этих скриптов. Для корректной работы этого варианта в системе должен быть установлен perl. Для его конфигурации надо добавить в файл [b]script.conf [/b]следующие строчки: поястение Думаю фаил называется conf.sh

Автор:	Gankov [ 20 мар 2008, 19:28 ]
Заголовок сообщения:
Таже страница цитата: Код: Для [b]правильно[/b] работы данного скрипта нужно настроить Ошибка

Автор:	stark [ 20 мар 2008, 20:25 ]
Заголовок сообщения:
Спасибо.Документация исправлена

Автор:

snark [ 12 ноя 2008, 02:59 ]

Заголовок сообщения:

Продолжим тему

Настройка модуля dialup

Изначально:

мануал писал(а):

Определите 3 услуги, связанные с этим модулем (название произвольное) - входящий и исходящий трафик, время. Услуга время обязательна, хотя может и считаться по нулевой цене.

Думаю будет лучше пониматься подобная конструкция:

Код:

Определите 3 услуги, связанные с этим модулем (название произвольное) - "Время", "Входящий трафик" и "Исходящий трафик". Услуга "Время" обязательна, хотя может и считаться по нулевой цене.

Там же:

мануал писал(а):

В конфигурации модуля установите:

Код:

<скип>
# пункты Web - меню
web.menuItem1=Просмотр сессий DialUp
web.menuItem2=Наработка по логинам DialUp
web.menuItem3=Cмена пароля на логины DialUp
web.menuItem4=Учетные периоды

Методом научного тыка было выяснено что необходимо дописать:

Код:

web.menuItem5=Управление динамическим ДНС

Иначе непонятно будет как убрать эту возможность из веба.

Там же, в настройке модуля, касательно DNS:

мануал писал(а):

Код:

login.parameter.1.listValue=Выключен;Цифровой логин;Логин входа

IMHO необходимо писать:

Код:

т.к. это больше соответствует логике БГБ (см. аттач), аналогично есть смысл изменить шаблон dialup.xsl.

Вложения:

bgb.jpg [ 12.33 КБ | Просмотров: 14529 ]

Автор:	Mike [ 10 дек 2008, 21:18 ]
Заголовок сообщения:
Очень хорошо отношусь к BGB, но каждый раз при работе раздражает везде встречающиеся "договорА". По-моему правильно писать "договорЫ", как и векторы (а не вектора), инженеры (а не инженера) и т.д. С огромным уважением к разработчикам

Автор:	dimOn [ 11 дек 2008, 14:20 ]
Заголовок сообщения:
Да, конечно же Вы правы - существительное "договор" фактически второго склонения. Но также в профессионально-жаргонной и разговорной речи допускается склонение по форме договор-договора (так же, как встречается такое и для вектор-вектора). Но документацию по возможности подправим, спасибо.

Автор:	snark [ 11 дек 2008, 15:33 ]
Заголовок сообщения:
dimOn писал(а): документацию по возможности подправим В процессе правки, прогоните ее, пожалуйста, через спеллчекер, а то там просто есть слова без недостающих букв либо опечатки.

Автор:	Администратор [ 25 дек 2008, 14:19 ]
Заголовок сообщения:
По услугам пока править не буду, т.к. в 4.6 все равно их придушим, а логично описать текущую схему не получится в силу ее нелогичности.. Цитата: Методом научного тыка было выяснено что необходимо дописать: Код: web.menuItem5=Управление динамическим ДНС Исправлено. Цитата: Там же, в настройке модуля, касательно DNS: мануал писал(а): login.parameter.1.listValue=Выключен;Цифровой логин;Логин входа Тут все правильно, это именно логин, под которым вошли. Не обязательно алиас.

Автор:	WhiteWind [ 07 янв 2009, 20:04 ]
Заголовок сообщения:
Весьма критичная опечатка: http://bgbilling.ru/v4.5/doc/ch07s08.html Цитата: MAX(<sid2>,<sid3>) - услуга <sid> вычисляется как максимум из услуг <sid2>, <sid3> на каждый из моментов обсчета MAX(<sid2>,<sid3>, <sid4>, <sid5>) - услуга <sid> вычисляется как сумма услуг <sid2>..<sid5> на каждый из моментов обсчета, количество параметров функции может быть от двух до четырех Вторая функция называется SUM, как можно догадаться из последующих примеров. Ещё одна, менее критичная, на той же странице: Цитата: Всех инспектора кроме универсального PoD работают по протоколу SNMP, SNMP порт и community устанавливаются следующим образом:

Автор:	Администратор [ 12 янв 2009, 14:46 ]
Заголовок сообщения:
Исправлено, спасибо.

Автор:	chili [ 14 янв 2009, 19:46 ]
Заголовок сообщения:
Долго держался, но все же решил написать. К сожалению, ваша документация отдельными местами составлена абсолютно безграмотными людьми и совершенно безответственным образом. Такое ощущение, что писал ученик первого класса. На "олбанском" языке. Количество опечаток просто огромное. Ошибки в пунктуации на каждом шагу, море орфографических, не говоря уже о стилистических. С версткой тоже все криво. Например, название кнопок можно было бы и кавычками выделять и жирным шрифтом. Это все мелочи, но временами бесить просто начинает. Такое наплевательское отношение к написанию текстов - это просто неуважение какое-то. Ну, заплатите уже вы разок корректору, чтобы он вычитал и отформатировал текст! Неужели это так сложно? Это же не в "аське" писать, это вроде как документ. Нужен пример? Пожалуйста! Последней каплей стало прочтение главы про КЛАДР - раздел "3. Использование плагина". Это просто шедевр! Объем текста мизерный. Я насчитал 18 ошибок.

Автор:	dimOn [ 14 янв 2009, 20:11 ]
Заголовок сообщения:
Да, конечно же Вы правы - наличие ошибок раздражает и утомляет грамотных людей, но Вы также должны понять, что документация составляется и дополняется в реальном времени самими разработчиками. Вам кажется, что стилистическая корректность и красивое форматирование важнее объективности и своевременности документации? После предыдущего замечания некоторые ошибки были исправлены и периодически доходит дело до постепенного исправления остальных. Документация не маленькая, и постоянно этим заниматься некому, но замечания учтём, постараемся со временем побороть неграмотность в документации.

Автор:	Jimson [ 05 фев 2009, 00:56 ]
Заголовок сообщения:
Наличие ошибок как раз таки нормальное явление, у меня тоже ошибки иногда так и прут при набивке текста на компе, другое дело что в указанном тексте про КЛАДР стилистика действительно албанская, без смеха читать невозможно ) В любом случае документация на БГбиллинг это больше техническая дока чем руководство пользователя, а технари сожрут любой стиль и любое колличество орфографических ошибок, технарям надо больше подробностей о том как именно реализована та или иная фича и как она взаимодействует с другим функционалом билинга. Излагать можно на албанском, главное побольше букв Скрины для учебника "бгбиллинг для чайников" лучше придержать.

Автор:	aardvark [ 11 мар 2009, 15:45 ]
Заголовок сообщения:	Нечитабельный скриншот.
http://bgbilling.ru/v4.5/doc/ch13s06.html - страница http://bgbilling.ru/v4.5/doc/resources/x_399.gif - скриншот. Рассмотреть данные на скриншоте невозможно, хотя ими надо руководствоваться при создании отчета.

Автор:	Администратор [ 18 мар 2009, 19:26 ]
Заголовок сообщения:
Поправлено.

Автор:	Heggi [ 29 май 2009, 01:07 ]
Заголовок сообщения:
Косяк в доке по установке BGRadiusIPN В конфигурации сервера необходимо еще указать параметры подключения к базе данных. О чем даже не упоминается. Более того. В самом архиве сервера в radius.properties нет никакого упоминания о БД.

Автор:	Феанор [ 03 июн 2009, 23:54 ]
Заголовок сообщения:
не документация, но все равно опечатка "Пополнение баланса карточкой Эксперсс-Оплаты" Или где то реально есть контора Эксперсс? =) Долго пытался понять где ошибка, когда клиенты скинули. И то не в первый день скинули. если что это в кабинете в пополнение баланса карточками.

Страница 3 из 11	Часовой пояс: UTC + 5 часов [ Летнее время ]
Powered by phpBB® Forum Software © phpBB Group http://www.phpbb.com/