문서서 제목 변경

문서의 제목을 변경해야 하는 경우, 이름을 여러 위치에서 업데이트해야 할 수 있습니다.

이 문서의 내용

문서 제목 변경하기

경우에 따라, 도움말 문서의 제목을 변경해야 합니다. 문서 제목을 다시 정할 때 유의해야 할 몇 가지 고려 사항이 있습니다.

파일명 변경의 배경

문서의 제목은 다음과 같은 몇 가지 이유로 해당 문서가 포함된 Markdown 파일의 이름과 직접적으로 일치합니다.

  • SEO: URL에서 문서의 내용과 상관 관계가 있는 실제 단어를 사용하는 경우, 검색 엔진에 대해 문서 가중치가 더 많이 적용됩니다. 자세한 내용은 Google 검색 엔진 최적화 시작 가이드의 ‘URL 구조 개선’을 참조하세요.

제목을 변경할 때 업데이트를 고려해야 하는 장소

문서에 새 제목을 지정할 때 업데이트해야 할 수 있는 여러 장소가 있습니다.

프런트 매터 및 메타데이터 구역

각 문서에는 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

부모 인덱스 파일

TOC를 생성하는 부모 index.md 파일의 해당 파일에 대한 링크를 업데이트해야 합니다.

설명서의 문서는 서로 연결됩니다. 파일명과 제목을 모두 검색하여 업데이트할 링크를 찾는 것이 좋습니다.

GitHub의 링크

제품에서 이전 제목 링크를 검색하세요. 오래된 링크를 발견하면, 관련 팀 또는 엔지니어에게 문의하여 링크가 변경되었음을 알리고 업데이트하도록 요청하세요. 누구에게 연락해야 할지 잘 모르는 경우, GitHub Docs 팀의 멤버에게 문의할 수 있습니다. 예의로, 업데이트된 링크로 끌어오기 요청을 만들고 업데이트된 문서 제목이 제공된 후 관련 팀에 이것을 병합하도록 요청할 수도 있습니다.