Commit 2cf9b979 authored by Pavel Beketov's avatar Pavel Beketov

correct README

parent 24e4efd3
...@@ -6,47 +6,47 @@ ...@@ -6,47 +6,47 @@
### **Описание задания** ### **Описание задания**
Задание состоит из двух частей: Задание состоит из двух частей:
1. Вам предстоит изучить работу команды **$ epm mark** и создать для нее документацию, а также провести тестирование. 1. Вам предстоит изучить работу команды **$ epm mark** и создать для нее документацию, а также провести тестирование;
2. Вам предстоит изучить скрипт **ping_check.sh**, найти ошибки в коде и исправить их, провести тестирование и составить документацию. 2. Вам предстоит изучить скрипт **ping_check.sh**, найти ошибки в коде и исправить их, провести тестирование и составить документацию.
### **Технические требования** ### **Технические требования**
1. Для выполнения задания требуется ОС Linux (рекомендуется ALT Linux). Вы можете установить ее в виртуальную среду (virtualbox). 1. Для выполнения задания требуется ОС Linux (рекомендуется ALT Linux). Вы можете установить ее в виртуальную среду (virtualbox);
2. Склонируйте репозиторий с заданием на свою машину, а ответы публикуйте в Вашем собственном репозитории на GitHub. 2. Склонируйте репозиторий с заданием на свою машину, а ответы публикуйте в Вашем собственном репозитории на GitHub.
## **Задача №1** ## **Задача №1**
### 1. **Установите EPM** ### 1. **Установите EPM**
- Это можно сделать командой: ```# curl -sL https://eepm.ru/epm.sh | bash /dev/stdin ei``` - Это можно сделать командой: ```# curl -sL https://eepm.ru/epm.sh | bash /dev/stdin ei```;
- Документация доступна по адресу https://wiki.eepm.ru - Документация доступна по адресу https://wiki.eepm.ru.
### 2. **Изучите команду epm mark** ### 2. **Изучите команду epm mark**
- Разберитесь, как работает команда. - Разберитесь, как работает команда;
- Проанализируйте ее поведение через запуск с различными аргументами - Проанализируйте ее поведение через запуск с различными аргументами.
### 3. **Напишите документацию** ### 3. **Напишите документацию**
Оформите ее в формате Markdown. Структура: Оформите ее в формате Markdown. Структура:
- Описание команды. - Описание команды;
- Синтаксис использования. - Синтаксис использования;
- Список опций/аргументов с пояснениями. - Список опций/аргументов с пояснениями;
- Примеры использования (1–3 сценария). - Примеры использования (1–3 сценария);
- Примечания (ограничения, зависимости, особенности) - Примечания (ограничения, зависимости, особенности).
### 4. **Протестируйте команду** ### 4. **Протестируйте команду**
- Проверьте основные сценарии работы. - Проверьте основные сценарии работы;
- Выявите возможные ошибки или неочевидное поведение. - Выявите возможные ошибки или неочевидное поведение;
- Составьте краткий отчет: что тестировали, какие баги обнаружили, как воспроизвести - Составьте краткий отчет: что тестировали, какие баги обнаружили, как воспроизвести.
### 5. **Предложите улучшения (опционально)** ### 5. **Предложите улучшения (опционально)**
На основе анализа дайте 2–3 рекомендации по оптимизации команды (например: добавление новых флагов, упрощение синтаксиса). На основе анализа дайте 2–3 рекомендации по оптимизации команды (например: добавление новых флагов, упрощение синтаксиса).
### **Требования к выполнению:** ### **Требования к выполнению:**
- Документация должна быть понятной для новичка, без технического жаргона. - Документация должна быть понятной для новичка, без технического жаргона;
- В примерах укажите команды и ожидаемый вывод. - В примерах укажите команды и ожидаемый вывод;
- В тестовом отчете выделите критические и незначительные баги (если есть). - В тестовом отчете выделите критические и незначительные баги (если есть).
### **Формат сдачи** ### **Формат сдачи:**
- Файл README.md с документацией. - Файл README.md с документацией.
- Файл TEST_REPORT.md с результатами тестирования и рекомендациями. - Файл TEST_REPORT.md с результатами тестирования и рекомендациями.
- Приложите краткие комментарии по структуре кода (что делает каждая часть). - Приложите краткие комментарии по структуре кода (что делает каждая часть).
...@@ -67,32 +67,32 @@ ...@@ -67,32 +67,32 @@
В репозитории Вам предоставлен Bash-скрипт **(ping_check.sh)**, который мониторит доступность хоста. В репозитории Вам предоставлен Bash-скрипт **(ping_check.sh)**, который мониторит доступность хоста.
### **Ваша задача:** ### **Ваша задача:**
1. Изучить код и описать его работу (что делает каждая часть скрипта). - Изучить код и описать его работу (что делает каждая часть скрипта);
2. Найти и исправить ошибки, которые мешают корректной работе. - Найти и исправить ошибки, которые мешают корректной работе;
3. Предложить улучшения для повышения надежности/функциональности. - Предложить улучшения для повышения надежности/функциональности (опционально).
### **Требования к выполнению** ### **Требования к выполнению**
#### **1. Описание работы скрипта:** #### **1. Описание работы скрипта:**
1. Объясните назначение скрипта, логику условий, использование переменных. - Объясните назначение скрипта, логику условий, использование переменных;
2. Укажите, какие данные куда записываются и при каких условиях. - Укажите, какие данные куда записываются и при каких условиях.
#### **2. Поиск ошибок:** #### **2. Поиск ошибок:**
1. Выявите все ошибки (синтаксические, логические, опечатки). - Выявите все ошибки (синтаксические, логические, опечатки);
2. Исправьте их в коде и объясните, как они влияли на работу. - Исправьте их в коде и объясните, как они влияли на работу;
3. Улучшения (опционально, но приветствуется). - Улучшения (опционально, но приветствуется);
4. Предложите изменения, которые сделают скрипт более надежным или удобным (опционально). - Предложите изменения, которые сделают скрипт более надежным или удобным (опционально).
### **Формат сдачи:** ### **Формат сдачи:**
- Исправленный скрипт ping_check.sh. - Исправленный скрипт ping_check.sh;
- Файл README.md с документацией по использованию скрипта и по структуре кода скрипта. - Файл README.md с документацией по использованию скрипта и по структуре кода скрипта;
- Файл TEST_REPORT.md с результатами тестирования. - Файл TEST_REPORT.md с результатами тестирования;
- Приложите краткие комментарии по улучшению кода (опционально). - Приложите краткие комментарии по улучшению кода (опционально);
- Приложите изменения, которые сделают скрипт более надежным или удобным (опционально). - Приложите изменения, которые сделают скрипт более надежным или удобным (опционально).
### Примечание ### Примечание
Ошибки считаются найденными, если Вы дали им техническое обоснование. **Ошибки считаются найденными, если Вы дали им техническое обоснование.**
### **Критерии оценки задачи №2** ### **Критерии оценки задачи №2**
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment