![[MC-04 logo]](/mc-04/chrome/site/logo.png){kind=logo}
#146 closed улучшение (готово)
Добавить в РЭ описание полной конфигурации Ethernet — at Version 29
| Reported by: | alx | Owned by: | Vladimir |
|---|---|---|---|
| Priority: | trivial | Component: | Руководство по эксплуатации |
| Keywords: | Cc: |
Description (last modified by )
alx:
Мы (разработчики блока 3U) не принимали решения, что полный вариант интерфейса не надо описывать вообще никогда, мы просто договорились, что описание функций, которые доступны только в нем (в виду не очень частого использования), отложим в "долгий ящик" на неопределенное "потом", так как есть много других более приоритетных задач по РЭ (например исправление имеющихся в нем ошибок).
Все, что есть в веб-интерфейсе, должно быть описано в документации, иначе пользователь не сможет этим пользоваться (так как не будет знать как).
san:
Создал wiki/Ethernet для описания полной конфигурации Ethernet, добавил туда описание колонки Pause, предлагаю по возможности добавлять на эту страничку описание настроек полной конфигурации ethernet и когда-нибудь добавить это всё в РЭ.
Change History (29)
comment:1 by , 7 years ago
| milestone: | Текущие работы → 2 очередь |
|---|
follow-up: 6 comment:2 by , 7 years ago
| Summary: | Добавить в руководство → Добавить в РЭ ethernet->Порты-> "Pause" |
|---|
comment:3 by , 6 years ago
| Owner: | changed from to |
|---|---|
| Status: | new → assigned |
comment:4 by , 5 years ago
В РЭ-41 в пункте "5.14.6 Вкладка "Ethernet" есть колонка "Pause",
но нет "Возможные состояния ячеек в этой колонке", а только чекбокс для галочки.
follow-up: 7 comment:6 by , 3 years ago
Replying to san:
В Демо открыл окно ethernet->Порты, но "Pause" там не увидел
В РЭ-51 есть вкладка:
6.2.3 Вкладка Ethernet - настройка коммутатора платы SW-01
и Рис.6.8 и тут тоже нет "Pause".
"Pause" есть в "5.14.6 Вкладка "Ethernet" (платы ST) "Рис. 5.62 Вкладка "Ethernet"
и есть в "5.4.3 Настройка платы TD-01", "Рис. 5.23 Вкладка Ethernet платы TD-01"
В какое место надо добавить "Pause"?
comment:7 by , 3 years ago
| Resolution: | → invalid |
|---|---|
| Status: | assigned → closed |
Replying to Vladimir:
В Демо открыл окно ethernet->Порты, но "Pause" там не увидел
В описании тикета есть важное уточнение - "полной конфигурации ethernet". В полной конфигурации ethernet в "Демо доступе" колонка "Pause" есть. Однако я забыл, что полный вариант конфигурации ethernet мы договорились пока (временно) не описывать. Поэтому тикет был создан по ошибке.
follow-up: 10 comment:8 by , 3 years ago
Replying to alx:
Начиная с sw:r1599 в веб-интерфейсе блока MC04-DSL-3U в таблице "Порты" полной конфигурации ethernet добавлена колонка "Pause", отображающая состояние приема/передачи кадров Pause. Возможные состояния ячеек в этой колонке:
В обычной (краткой) конфигурации я не нашёл слово "Pause"
(упустил из вида слово "в таблице "Порты" полной конфигурации ethernet".
САН подсказал, что надо зайти в "Разное" и выбрать "Конфигурация Ethernet полная",
однако, отметил, что в РЭ ещё не описана ни одна вкладка, добавляемая в конфигурации "полная", а это дополнительно 11 новых вкладок по сравнению с конфигом "краткая" и САН сомневается, надо ли описывать в РЭ все 22 вкладки вместо имеющихся 11.
Если надо, то где найти описание про остальные 10 вкладок конфига "полная",
а если не надо, то зачем тогда описывать "Pause" - одну из 11 дополнительных вкладок?
- "RX" - из порта принят кадр Pause, передача в порт приостановлена;
- "TX" - в порт передаются кадры Pause для приостановки передачи удаленной стороной;
- "RX/TX" - из порта принят кадр Pause, передача в порт приостановлена, одновременно в порт передаются кадры Pause для приостановки передачи удаленной стороной;
- пусто - кадры Pause не принимаются из порта и не передаются в порт, передача данных возможна в обоих направлениях.
Первые три состояния отображаются на красном фоне.
Надо добавить описание этой функции в руководство.
На это САН не дал однозначного и решительного ответа "быть или не быть"
вкладке "Pause" в РЭ, если быть, то это будет первый подобный прецедент в РЭ.
Кстати, в "Конфигурация Ethernet полная" появляется дополнительная кнопка
"Analyzer Configuration" по которой открывается новое окно
"Analyzer ports Configuration", которое тоже никогда не было описано в РЭ
и даже слова "Analyzer" в РЭ нет и не было. Это тогда тоже надо описывать?
follow-up: 11 comment:9 by , 3 years ago
Replying to alx:
Начиная с sw:r1599 в веб-интерфейсе блока MC04-DSL-3U в таблице "Порты" полной конфигурации ethernet добавлена колонка "Pause", отображающая состояние приема/передачи кадров Pause.
На будущее: если тикет предназначен мне, то указывай поточнее где и как найти нужное место,
а ещё лучше добавить и полное описание, например, в Вики.
В данном случае я не вспомнил, что для доступа к указанной вкладке и указанной колонке надо сначала зайти на вкладку "Разное", там выбрать "полное" и снова открыть вкладку Ethernet -
это мне уже подсказал САН.
follow-up: 14 comment:10 by , 3 years ago
Replying to Vladimir:
САН сомневается, надо ли описывать в РЭ все 22 вкладки вместо имеющихся 11.
Если интересно мое мнение (раз уж я создатель данного тикета), то оно состоит в том, что все, что есть в веб-интерфейсе, должно быть описано в документации. Логика в данном случае проста: если что-то не будет описано в документации, то пользователь не сможет этим пользоваться (так как не будет знать как).
Как я уже написал в предыдущем комментарии, мы (разработчики блока 3U) не принимали решения, что полный вариант интерфейса не надо описывать вообще никогда, мы просто договорились, что описание функций, которые доступны только в нем (в виду не очень частого использования), отложим в "долгий ящик" на неопределенное "потом", так как есть много других более приоритетных задач по РЭ (например исправление имеющихся в нем ошибок). Вот так лично я помню наше решение по данному вопросу. Если ты считаешь, что уже пришла пора описать и полный вариант интерфейса тоже, то я это только приветствую.
Если надо, то где найти описание про остальные 10 вкладок конфига "полная",
Спросить у разработчика, то есть у меня. Неожиданный ответ, правда? :)
Надо добавить описание этой функции в руководство.
На это САН не дал однозначного и решительного ответа "быть или не быть"
Насколько я вижу, san этот тикет видел (и даже делал несколько технических правок), однако не закрыл его. Следовательно, он, как минимум, не возражает против сделанного мной (по ошибке) предложения. Если считаешь, что пришло время начать описывать полный вариант настроек ethernet, переоткрой этот тикет.
Кстати, в "Конфигурация Ethernet полная" появляется дополнительная кнопка
"Analyzer Configuration"
Эта "новая кнопка" появилась приблизительно 10 лет назад. :)
по которой открывается новое окно
"Analyzer ports Configuration", которое тоже никогда не было описано в РЭ
и даже слова "Analyzer" в РЭ нет и не было. Это тогда тоже надо описывать?
Как я уже написал выше, все, что есть в веб-интерфейсе, должно быть описано в документации, иначе пользователь не сможет этим пользоваться (так как не будет знать как).
follow-up: 13 comment:11 by , 3 years ago
Replying to Vladimir:
На будущее: если тикет предназначен мне, то указывай поточнее где и как найти нужное место,
На настоящее: я так и делаю. Например в описании этого тикета сказано: "в веб-интерфейсе блока MC04-DSL-3U в таблице "Порты" полной конфигурации ethernet".
comment:12 by , 3 years ago
Я не возражаю против описания полных настроек Eth и в принципе согласен с Алексеем.
Но на мой взгляд в РЭ пока хватает намного более значимых пробелов, чем описание этих действительно редко используемых настроек. Когда-то давно мы их "спрятали" и время открывания долгого ящика пока не пришло, на мой взгляд.
follow-up: 15 comment:13 by , 3 years ago
Replying to alx:
Replying to Vladimir:
На будущее: если тикет предназначен мне, то указывай поточнее где и как найти нужное место,
На настоящее: я так и делаю. Например в описании этого тикета сказано: "в веб-интерфейсе блока MC04-DSL-3U в таблице "Порты" полной конфигурации ethernet".
Но я же пока "незнайка" в этом вопросе, поэтому долго искал, нашёл таблицу Порты, искал там "Pause", не нашёл, проделал кучу лишних телодвижений, не нашёл и пошёл пешком к САН, отвлёк его от работы, чтобы войсом спросить - где же нужная "Pause" находится и как, через что туда попасть и только от него узнал, что надо проделать ещё кучку движений (см. комм-9).
Это у тебя всё быстро на автопилоте получается (пальцы сами набирают то, что надо ;-) ),
а мне надо долго искать :-)
follow-up: 16 comment:14 by , 3 years ago
Replying to alx:
Replying to Vladimir:
САН сомневается, надо ли описывать в РЭ все 22 вкладки вместо имеющихся 11.
Если интересно мое мнение, то оно состоит в том, что все, что есть в веб-интерфейсе, должно быть описано в документации. Логика в данном случае проста: если что-то не будет описано в документации, то пользователь не сможет этим пользоваться (так как не будет знать как).
И это правильно!
...Если ты считаешь, что уже пришла пора описать и полный вариант интерфейса тоже, то я это только приветствую.
Я подумал, что полный интерфейс надо напечатать в отдельном Приложении,
а в тексте дать ссылку.
Если надо, то где найти описание про остальные 10 вкладок конфига "полная",
Спросить у разработчика, то есть у меня. Неожиданный ответ, правда? :)
Лучше бы разработчик выпустил тикет со ссылками на описание дополнительных вкладок
(чтобы не забыть про то, что надо бы дать описание)
Насколько я вижу, san этот тикет видел (и даже делал несколько технических правок), однако не закрыл его. Следовательно, он, как минимум, не возражает против сделанного мной (по ошибке) предложения. Если считаешь, что пришло время начать описывать полный вариант настроек ethernet, переоткрой этот тикет.
Я ещё не научился переоткрывать тикеты, а у тебя это ловко получается -
вот и переоткрыл бы на долгую и добрую память :-) (без этого я забуду)
Когда я закончу оставшиеся 88 тикетов, то возьмусь и за это
(если будут ссылки на подробные Вики-статьи про это ;-) ).
Кстати, в "Конфигурация Ethernet полная" появляется дополнительная кнопка
"Analyzer Configuration"
Эта "новая кнопка" появилась приблизительно 10 лет назад. :)
Для меня - первый раз за все 73 года жизни :-)
по которой открывается новое окно
"Analyzer ports Configuration", которое тоже никогда не было описано в РЭ
и даже слова "Analyzer" в РЭ нет и не было. Это тогда тоже надо описывать?
Как я уже написал выше, все, что есть в веб-интерфейсе, должно быть описано в документации, иначе пользователь не сможет этим пользоваться (так как не будет знать как).
Оформил бы ты на память тикет и про это с минимальным приоритетом!
follow-up: 22 comment:15 by , 3 years ago
Replying to Vladimir:
Но я же пока "незнайка" в этом вопросе, поэтому долго искал, нашёл таблицу Порты, искал там "Pause", не нашёл, проделал кучу лишних телодвижений, не нашёл и пошёл пешком к САН, отвлёк его от работы, чтобы войсом спросить - где же нужная "Pause" находится и как, через что туда попасть и только от него узнал, что надо проделать ещё кучку движений (см. комм-9).
Разве тебе пришлось делать все описанное выше из-за того, что я не указал, где находится колонка "Pause"? В comment:8 ты сам написал почему:
упустил из вида слово "в таблице "Порты" полной конфигурации ethernet".
Потому что ты упустил то, что я написал, а не потому, что я не написал... Я, конечно, сожалею, что тебе пришлось проделать путь до san и обратно, но свою вину вижу лишь в том, что по ошибке этот тикет создал. Еще раз прошу за это прощения.
follow-up: 24 comment:16 by , 3 years ago
| Resolution: | invalid |
|---|---|
| Status: | closed → reopened |
Replying to Vladimir:
Я подумал, что полный интерфейс надо напечатать в отдельном Приложении,
а в тексте дать ссылку.
Лично я смысла в таком отделении не вижу, но разработчик - ты, тебе и решать.
Лучше бы разработчик выпустил тикет со ссылками на описание дополнительных вкладок
(чтобы не забыть про то, что надо бы дать описание)
Хорошо, выпущу по мере возможности. Но тогда проще прямо в тикетах и писать - зачем плодить лишние сущности и лишние ссылки?
Я ещё не научился переоткрывать тикеты,
Это совсем не сложно: в разделе "Изменить карточку" в панели "действия" ставишь радиобатон на пункт "reopen".
а у тебя это ловко получается - вот и переоткрыл бы на долгую и добрую память :-) (без этого я забуду)
По твоей просьбе переоткрыл тикет.
Кстати, в "Конфигурация Ethernet полная" появляется дополнительная кнопка
"Analyzer Configuration"
Эта "новая кнопка" появилась приблизительно 10 лет назад. :)
Для меня - первый раз за все 73 года жизни :-)
Вот я и говорю, что для тебя вообще все, что разработано в АДС - это "недавно".
Оформил бы ты на память тикет
Как я уже пообещал, буду писать тикеты по мере возможности (свободного времени).
и про это с минимальным приоритетом!
Владелец тикетов - ты, вот ты и распределяй задачи по приоритетам, как считаешь нужным и правильным.
follow-ups: 19 28 29 comment:17 by , 3 years ago
| Description: | modified (diff) |
|---|---|
| Priority: | major → trivial |
Создал wiki/Ethernet для описания полной конфигурации Ethernet, добавил туда описание колонки Pause, предлагаю по возможности добавлять на эту страничку описание настроек полной конфигурации ethernet.
по ошибке этот тикет создал
Расширю тему тикета до предложения описать настройки полной конфигурации ethernet.
comment:18 by , 3 years ago
| Summary: | Добавить в РЭ ethernet->Порты-> "Pause" → Добавить в РЭ описание полной конфигурации Ethernet |
|---|
comment:19 by , 3 years ago
Replying to san:
Создал wiki/Ethernet для описания полной конфигурации Ethernet, добавил туда описание колонки Pause, предлагаю по возможности добавлять на эту страничку описание настроек полной конфигурации ethernet.
Не понимаю, в чем смысл иметь дубликат того, что описано в РЭ. Ты сам всегда говорил, что это нерационально - каждый раз, когда что-то изменится в аппаратуре, придется изменять описание сразу в двух местах - в РЭ и в wiki...
follow-up: 21 comment:20 by , 3 years ago
иметь дубликат
Если эта информация таки попадёт в РЭ страничку можно будет удалить.
Иногда какие-то кусочки описания появляются сами собой, например когда одному из пользователей объясняешь что-то, или вот ты по ошибке написал кусочек описания. Эти кусочки пока недостаточны для добавления в РЭ, но лучше чем совсем ничего.
comment:21 by , 3 years ago
Replying to san:
Иногда какие-то кусочки описания появляются сами собой, например когда одному из пользователей объясняешь что-то,
Насколько я могу видеть, за последние 10 лет ни одного кусочка описания полных настроек ethernet "само собой" не появилось. :)
или вот ты по ошибке написал кусочек описания.
Так я же его написал не в wiki, а в тикете, и дальше предлагал делать так же...
comment:22 by , 3 years ago
Replying to alx:
Replying to Vladimir:
упустил из вида слово "в таблице "Порты" полной конфигурации ethernet".
Потому что ты упустил то, что я написал, а не потому, что я не написал... Я, конечно, сожалею, что тебе пришлось проделать путь до san и обратно, но свою вину вижу лишь в том, что по ошибке этот тикет создал. Еще раз прошу за это прощения.
Вот если бы у тебя было написано, как у САН в https://trac.adc-line.ru/sw-01/intertrac/wiki/Ethernet (см.комм-17):
"Для отображения расширенных настроек Ethernet нужно на вкладке "Разное" в настройке "Конфигурация Ethernet" выбрать вариант "полная".", то любой юзер и я нашли бы очень очень быстро нужную вкладку без посторонней помощи :-)
follow-up: 25 comment:23 by , 3 years ago
ни одного кусочка описания полных настроек ethernet "само собой" не появилось. :)
По другим вопросам иногда появляется. То что не "готово" войти в РЭ, но представляет интерес для пользователя я иногда добавляю в вики, думаю что это более логичное место поиска информации чем тикет.
follow-up: 26 comment:24 by , 3 years ago
Replying to alx:
Replying to Vladimir:
Я подумал, что полный интерфейс надо напечатать в отдельном Приложении,
а в тексте дать ссылку.
Лично я смысла в таком отделении не вижу, но разработчик - ты, тебе и решать.
Смысл в том, чтобы не засорять и без того огромный текст РЭ информацией, которой крайне редко пользуются на эксплуатации (это должно бы быть подробное описание 11 новых вкладок).
Но решать по рангу должен бы САН - он чаще общается с юзерами и ему видней.
... проще прямо в тикетах и писать - зачем плодить лишние сущности и лишние ссылки?
В тикетах пишут кратко, тезисно, для РЭ желательно подробнее, а огромные тикеты это не хорошо.
в разделе "Изменить карточку" в панели "действия" ставишь радиобатон на пункт "reopen".
Спасибо.
comment:25 by , 3 years ago
Replying to san:
ни одного кусочка описания полных настроек ethernet "само собой" не появилось. :)
По другим вопросам иногда появляется. То что не "готово" войти в РЭ, но представляет интерес для пользователя я иногда добавляю в вики, думаю что это более логичное место поиска информации чем тикет.
Тикеты приходят мне на почту и автоматически попадают в папку "TRAC",
причём жирным шрифтом с сортировкой во дате-времени и я их сразу вижу,
а новые Вики я могу пропустить и не увидеть, и не узнать, и не использовать...
Поэтому ссылка в тикете мне удобнее: я сразу из мэйлера могу открыть и тикет и Вики.
follow-up: 27 comment:26 by , 3 years ago
Replying to Vladimir:
В тикетах пишут кратко, тезисно,
Кто и когда установил такое правило? :) Мне о нем ничего не известно.
comment:27 by , 3 years ago
Replying to alx:
Replying to Vladimir:
В тикетах пишут кратко, тезисно,
Кто и когда установил такое правило? :) Мне о нем ничего не известно.
Мне так показалось, т.к. тикеты чаще всего относительно короткие,
а реализация в РЭ занимает много страниц, чаще всего взятых из Вики,
т.е. это не правило, а скорее де-факто с редкими исключениями :-)
comment:28 by , 2 years ago
Replying to san:
Создал wiki/Ethernet для описания полной конфигурации Ethernet, добавил туда описание колонки Pause, предлагаю по возможности добавлять на эту страничку описание настроек полной конфигурации ethernet.
Расширю тему тикета до предложения описать настройки полной конфигурации ethernet.
Эта огромная Вики-статья уже созрела для публикации в РЭ или ждём ещё 5 лет? :-)
Я тут ничего изменить/добавить/убавить не могу...
На данный момент это самый старый тикет, который касается РЭ.
comment:29 by , 2 years ago
| Description: | modified (diff) |
|---|---|
| Resolution: | → готово |
| Status: | reopened → closed |
Replying to san:
В РЭ-55 от 01.12.2022 добавил ссылку на полную конфигурацию вкладки Ethernet.
Расширю тему тикета до предложения описать настройки полной конфигурации ethernet.
В пункте "6.2.3 Вкладка Ethernet - настройка коммутатора платы SW-01" по предложению САН дополнил текст:
"Рис. 6.8 Вкладка Ethernet отображает состояние портов коммутатора платы SW-01.
Описание вкладки Ethernet приводится в режиме краткая (см. на Рис. 6.9 табличку Конфигурация Ethernet вкладки Разное). Описание вкладки Ethernet в режиме полная
доступно по ссылке: https://trac.adc-line.ru/sw-01/wiki/Ethernet (расширенные настройки)."
Milestone renamed