Запуск локальної копії веб-сайту docs.rockylinux.org для веб-розробників та/або авторів вмісту¶
У цьому документі описано, як відтворити та запустити локальну копію всього веб-сайту docs.rockylinux.org на вашій локальній машині. Це незавершено.
Запуск локальної копії веб-сайту документації може бути корисним у таких випадках:
- Вам цікаво дізнатися про аспекти веб-розробки веб-сайту docs.rockylinux.org і зробити свій внесок у них
- Ви автор і хотіли б побачити, як ваші документи відображатимуться/виглядатимуть на веб-сайті документів, перш ніж надсилати їх
- Ви веб-розробник, який хоче внести свій внесок або допомогти підтримувати веб-сайт docs.rockylinux.org
Декілька нотаток¶
- Інструкції в цьому посібнику НЕ є обов’язковою умовою для авторів/учасників документації Rocky
- Усе середовище працює в контейнері Docker, тому вам знадобиться механізм Docker на вашій локальній машині
- Контейнер створено на основі офіційного образу докера RockyLinux, доступного тут https://hub.docker.com/r/rockylinux/rockylinux
- Контейнер зберігає вміст документації (посібники, книги, зображення тощо) окремо від веб-механізму (mkdocs)
- Контейнер запускає локальний веб-сервер, який прослуховує порт 8000. І порт 8000 буде перенаправлено на хост Docker
Створення середовища вмісту¶
-
Змініть поточний робочий каталог у вашій локальній системі на папку, у якій ви збираєтеся писати. Ми називатимемо цей каталог як
$ROCKYDOCS
в решті цього посібника. Для нашої демонстрації тут$ROCKYDOCS
вказує на~/projects/rockydocs
у нашій демонстраційній системі.Створіть $ROCKYDOCS, якщо він ще не існує, а потім введіть:
cd $ROCKYDOCS
-
Переконайтеся, що у вас встановлено
git
(dnf -y install git
). Перебуваючи в $ROCKYDOCS, використовуйте git, щоб клонувати офіційне сховище вмісту Rocky Documentation. Впишіть:git clone https://github.com/rocky-linux/documentation.git
Тепер у вас буде папка $ROCKYDOCS/documentation
. Ця папка є репозиторієм git і знаходиться під контролем git.
Створіть і запустіть середовище веб-розробки RockyDocs¶
-
Переконайтеся, що Docker запущено та працює на вашій локальній машині (ви можете перевірити за допомогою
systemctl
) -
З терміналу впишіть наступне:
docker pull wsoyinka/rockydocs:latest
-
Переконайтеся, що зображення завантажено успішно. Впишіть:
docker image ls
Запуск контейнера RockyDocs¶
-
Запустіть контейнер із зображення rockydocs. Впишіть:
docker run -it --name rockydoc --rm \ -p 8000:8000 \ --mount type=bind,source="$(pwd)"/documentation,target=/documentation \ wsoyinka/rockydocs:latest
Крім того, за бажанням і якщо у вас встановлено
docker-compose
, ви можете створити файл створення під назвоюdocker-compose.yml
із таким вмістом:version: "3.9" services: rockydocs: image: wsoyinka/rockydocs:latest volumes: - type: bind source: ./documentation target: /documentation container_name: rocky ports: - "8000:8000"
Збережіть файл із назвою
docker-compose.yml
у робочому каталозі $ROCKYDOCS. І запустіть службу/контейнер, виконавши:docker-compose up
Перегляньте місцевий веб-сайт docs.rockylinux.org¶
Коли контейнер запущений і запущений, тепер ви зможете вказати свій веб-браузер за такою URL-адресою, щоб переглянути локальну копію сайту:
Author: Wale Soyinka
Contributors: Steve Spencer, Ganna Zhyrnova