16.2 Присоединяйтесь к созданию книги¶
Возможности автора ограничены, поэтому в книге неизбежно могут встречаться упущения и ошибки. Просим отнестись к этому с пониманием. Если вы заметите опечатки, неработающие ссылки, пропуски в содержании, двусмысленные формулировки, неясные объяснения или неудачную структуру изложения, пожалуйста, помогите нам это исправить, чтобы читатели получили более качественный учебный ресурс.
Все GitHub ID авторов будут указаны на главных страницах репозитория книги, веб-версии и PDF-версии в знак благодарности за их бескорыстный вклад в сообщество открытого исходного кода.
Сила открытого исходного кода
Интервал между двумя тиражами бумажной книги обычно довольно велик, поэтому обновлять содержание очень неудобно.
В этой же открытой книге цикл обновления содержания сокращается до нескольких дней, а иногда даже до нескольких часов.
1. Небольшие правки содержания¶
Как показано на рисунке 16-3, в правом верхнем углу каждой страницы есть «значок редактирования». Текст или код можно изменить следующим образом.
- Нажмите на «значок редактирования». Если появится сообщение «You need to fork this repository», согласитесь с этим действием.
- Измените содержимое исходного Markdown-файла, проверьте корректность правок и постарайтесь сохранить единый стиль оформления.
- Внизу страницы заполните описание изменений, затем нажмите кнопку «Propose file change». После перехода на следующую страницу нажмите кнопку «Create pull request», чтобы отправить pull request.
Рисунок 16-3 Кнопка редактирования страницы
Изображения нельзя изменить напрямую, поэтому проблему с ними нужно описывать через новый Issue или комментарий. Мы постараемся как можно быстрее исправить и обновить изображение.
2. Создание содержания¶
Если вам интересно участвовать в этом проекте с открытым исходным кодом, например переводить код на другие языки программирования или расширять содержание статей, то следует придерживаться следующего процесса Pull Request.
- Войдите в GitHub и сделайте Fork репозитория книги в свой личный аккаунт.
- Перейдите на страницу своего Fork-репозитория и с помощью команды
git cloneклонируйте репозиторий локально. - Создавайте и редактируйте содержание локально, затем проведите полное тестирование и проверьте корректность кода.
- Зафиксируйте локальные изменения, после чего выполните Push в удаленный репозиторий.
- Обновите страницу репозитория и нажмите кнопку «Create pull request», чтобы инициировать pull request.
3. Развертывание Docker¶
В корневом каталоге hello-algo выполните следующий Docker-скрипт, после чего проект станет доступен по адресу http://localhost:8000:
Удалить развертывание можно следующей командой: