Иногда необходимо изменить название статьи справки. При повторе статьи следует учитывать несколько соображений.
Заголовок статьи соответствует непосредственно имени файла Markdown, содержащего следующую статью, по нескольким причинам:
- SEO: Когда мы используем реальные слова, которые коррелируют с содержанием статьи в URL-адресе, наши статьи взвешиваются более сильно для поисковых систем. Дополнительные сведения см. в разделе "Улучшение структуры URL-адресов" в руководстве по оптимизации поисковой системы Google.
Вам может потребоваться обновить несколько мест, когда вы даете статью новое название.
Каждая статья содержит раздел метаданных или frontmatter, расположенный в верхней части статьи , форматируемой с помощью синтаксиса YAML. Этот раздел метаданных создает заголовок статьи и содержит другие важные данные, такие как перенаправления, а иногда и даже краткое описание, которое связывается с повторно используемым текстом.
---
title: Your article name
intro:
redirect_from:
- /articles/older-outdated-article-name/
---
- Обновление заголовка с помощью варианта предложения
- Обновление перенаправлений. Почти каждый раз, когда мы повторяем статью, мы должны добавить перенаправление, ссылающееся на старый URL-адрес статьи, и убедитесь, что мы сохраняем все перенаправления в интерфейсном шаблоне старой статьи.
Чтобы изменить имя файла, можно использовать git mv команду в терминале.
$ git mv old-article-name.md new-article-name.md
Обязательно обновите ссылку на файл в родительском index.md файле, который создает TOC.
Мы связываемся между статьями в нашей документации. Рекомендуется искать имя файла и заголовок, чтобы найти ссылки для обновления.
Найдите в продукте ссылки на старое название. Если вы найдете устаревшие ссылки, обратитесь к соответствующей группе или инженерам, чтобы сообщить им, что ссылка изменилась и попросите их обновить. Если вы не уверены, кто нужно связаться, вы можете попросить участника команды Docs . Как любезно, вы также можете создать запрос на вытягивание с обновленными ссылками и попросить соответствующую команду объединить его после обновленных заголовков статей.