Збирання та локальна робота з сайтом
Після внесення змін до нашого сайту, переконайтесь, що вони відображаються так, як ви очікуєте. Щоб переглянути зміни локально, ми маємо інструменти, які дозволяють легко побудувати та переглядати їх. Ми використовуємо автоматизовані тести для перевірки якості всіх внесків. Перед поданням змін у Pull Request (PR), також потрібно запустити тести локально.
Перед початком
Щоб гарантувати, що тести, які ви запускаєте локально, використовують ті ж версії, що і тести в Continuous Integration (CI) Istio, ми надаємо Docker-образ з усіма необхідними інструментами, включаючи наш генератор сайту: Hugo.
Щоб побудувати, протестувати та переглянути сайт локально, потрібно встановити Docker у вашу систему.
Перегляд змін
Щоб переглянути ваші зміни на сайті, перейдіть до кореня вашого форку istio/istio.io та запустіть наступну команду:
$ make serveЯкщо у ваших змінах немає помилок збірки, команда побудує сайт і запустить локальний вебсервер для його розміщення. Щоб переглянути локальну збірку сайту, перейдіть на http://localhost:1313 у вашому вебоглядачі.
Якщо вам потрібно зібрати та обслуговувати сайт з віддаленого сервера, ви можете використовувати ISTIO_SERVE_DOMAIN, щоб надати IP-адресу або DNS домен сервера, наприклад:
$ make ISTIO_SERVE_DOMAIN=192.168.7.105 serveЦей приклад збирає сайт і запускає вебсервер, який розміщує сайт на віддаленому сервері з IP-адресою 192.168.7.105. Як і раніше, ви можете підключитися до вебсервера за адресою http://192.168.7.105:1313.
Тестування змін
Ми використовуємо лінтери та тести, щоб забезпечити базовий рівень якості контенту сайту через автоматизовані перевірки. Ці перевірки повинні проходити без помилок, щоб ми могли схвалити ваш внесок. Переконайтеся, що ви запускаєте перевірки локально перед поданням змін до репозиторію через PR. Ми проводимо такі автоматизовані перевірки:
Перевірка HTML: забезпечує, що всі посилання є дійсними разом з іншими перевірками.
Перевірка орфографії: забезпечує правильність написання контенту.
Перевірка стилю Markdown: забезпечує, що розмітка відповідає нашим правилам стилю Markdown.
Щоб запустити ці перевірки локально, використовуйте наступну команду:
$ make lintЯкщо перевірка орфографії виявляє помилки, найімовірніші причини:
Реальна помилка: Виправте помилку у ваших Markdown-файлах.
Помилка вказана для команди, поля чи символу: Огорніть вміст з помилкою в `зворотні лапки`.
Помилка вказана для правильного слова чи власної назви, що відсутнє у словнику інструмента: Додайте слово до файлу
.spellingу корені репозиторіюistio/istio.io.
Через погане підключення до Інтернету ви можете зіткнутися з проблемами з перевіркою посилань. Якщо у вас виникають проблеми з підключенням, ви можете налаштувати перевірку, щоб вона не перевіряла зовнішні посилання. Встановіть змінну середовища INTERNAL_ONLY у True під час запуску лінтера, наприклад:
$ make INTERNAL_ONLY=True lintКоли ваш контент пройде всі перевірки, подайте його до репозиторію через PR. Відвідайте Робота з GitHub для отримання додаткової інформації.