Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Create doc for subsystem integration management #115

Open
wants to merge 11 commits into
base: develop
Choose a base branch
from
+278 −2
Open

Create doc for subsystem integration management #115

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
3911017
#101 разработка документации к подсистеме управления интеграциями
thvvmas Oct 7, 2024
e3f1505
Списки перенумерованы
thvvmas Oct 7, 2024
4cf5cd6
Перенумерация списков, добавление ссылок на компоненты общих макетов …
thvvmas Oct 7, 2024
cf39ab6
Обновлены ссылки на другие страницы документации
thvvmas Oct 7, 2024
5394ef4
Добавлена ссылка на заголовок. Исправлены некоторые ошибки в тексте
thvvmas Oct 7, 2024
728cdba
Исправлена ссылка на заголовок
thvvmas Oct 7, 2024
f811bda
Добавлен заголовок связанных подсистем и описание создания предопреде…
thvvmas Oct 7, 2024
a4e1396
Добавлены примеры заполнения настроек для FTP-сервера и HTTP-сервиса.…
thvvmas Oct 8, 2024
9cac35b
Исправил обозначение кода в md
thvvmas Oct 16, 2024
0cfef6e
Исправление некоторых ошибок документации
thvvmas Oct 17, 2024
aa94569
Update README.md
ivanmolodec Oct 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
2. [Соответствия объектов ИБ](docs/СоответствиеОбъектовИнформационнойБазы.md)
3. [Программная модификация форм](docs/МодификацияФорм.md)
4. [Подписки на события](docs/ПодпискиНаСобытия.md)
5. Управление интеграциями
5. [Управление интеграциями](docs/УправлениеИнтеграциями.md)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

Numbering Issues Found in README.md

The linked document for the "Управление интеграциями" (Integration Management) subsystem exists and the addition is approved. However, there are numbering inconsistencies in the list:

  • The numbering jumps incorrectly, causing a total of 6 issues.

Please correct the numbering to ensure it is sequential and consistent.

🔗 Analysis chain

Approve the addition of the Integration Management subsystem link with suggestions.

The addition of the hyperlink for the "Управление интеграциями" (Integration Management) subsystem improves navigation and is consistent with other subsystem entries. However, there are a few points to consider:

  1. The numbering of the list items seems off. It jumps from 4 to 22, which appears to be a formatting error.
  2. Consider internationalizing the documentation or providing translations for non-Russian speakers to improve accessibility.

Could you please correct the numbering of the list items to ensure consistency?

Let's verify if the linked document exists:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Verify the existence of the linked document
if [ -f "docs/УправлениеИнтеграциями.md" ]; then
    echo "The linked document exists."
else
    echo "Warning: The linked document 'docs/УправлениеИнтеграциями.md' does not exist."
fi

Length of output: 265

Script:

#!/bin/bash
# Check the numbering sequence in the list in README.md

# Extract all numbered list items
grep -E '^[0-9]+\.' README.md | awk '{print $1}' | sed 's/\.//' > list_numbers.txt

# Initialize expected number
expected=1
issues=0

# Read each number and compare with expected
while read -r number; do
    if [ "$number" -ne "$expected" ]; then
        echo "Numbering issue: expected $expected but found $number"
        issues=$((issues + 1))
    fi
    expected=$((expected + 1))
done < list_numbers.txt

# Final result
if [ $issues -eq 0 ]; then
    echo "List numbering is sequential."
else
    echo "List numbering has $issues issue(s)."
fi

Length of output: 1540

6. [Пользовательские функции](docs/ПользовательскиеФункции.md)
7. [Настройки отбора объектов](docs/ПолучениеДанныхПоНастройкеОтбора.md)
8. [Загрузка файла через табличный документ](docs/ЗагрузкаФайлаЧерезТабличныйДокумент.md)
Expand Down
Loading
Loading