InfoGrab DocsInfoGrab Docs

링크와 비디오

GitLab 문서에서 링크, 링크 텍스트, 비디오, 클릭 스루 데모에 적용하는 규칙을 설명합니다.

링크 # 링크는 독자가 필요한 내용을 찾도록 돕는 중요한 수단입니다. 그러나 대부분의 콘텐츠는 검색으로 찾으므로, 한 페이지에 링크를 너무 많이 넣지 않아야 합니다. 링크가 너무 많으면 가독성이 떨어질 수 있습니다. 같은 페이지에서 링크를 중복하지 않습니다. 예를 들어 페이지 A 에서 페이지 B 로 여러 번 링크하지 않습니다. 제목에는 링크를 사용하지 않습니다. 링크가 들어간 제목은 오류를 일으킵니다. 링크 안의 단어 사이에서 강제로 줄을 바꾸지 않습니다. 한 문단에 링크를 여러 개 넣지 않도록 합니다. 한 작업에 링크를 여러 개 넣지 않도록 합니다. 한 페이지에서 다른 페이지로 연결하는 링크는 15개를 넘기지 않도록 합니다. 작업 흐름을 방해하는 링크를 줄이려면 관련 주제 를 사용하는 방안을 고려합니다. 같은 페이지의 섹션으로 연결하는 앵커 링크는 가급적 사용하지 않습니다. 사용자가 오른쪽 탐색을 활용하도록 합니다. 인라인 링크 # 참조 링크 대신 인라인 링크를 사용합니다. 인라인 링크가 해석하고 수정하기 더 쉽습니다. ( Vale 규칙: ReferenceLinks.yml ) 권장: For more information, see [ merge requests ]( path/to/merge_requests.md ) 비권장: For more information, see [ merge requests ][ 1 ]. [ 1 ]: path/to/merge_requests.md 같은 리포지터리 안의 링크 # 같은 리포지터리에 있는 다른 문서( .md ) 파일로 링크하려면 다음과 같이 합니다. 상대 파일 경로를 사용한 인라인 링크를 사용합니다. 예: [GitLab.com settings](../user/gitlab_com/_index.md) . 링크가 매우 길더라도 링크 전체를 한 줄에 넣습니다. ( Vale 규칙: MultiLineLinks.yml ) Note GitLab 리포지터리에서는 다른 어떤 디렉터리에서도 /development 디렉터리로 링크하지 않습니다. 개발 문서에서 특정 코드 파일로 링크하는 경우처럼 문서 파일 밖의 파일로 링크하려면 다음과 같이 합니다. 전체 URL을 사용합니다. 예: [`app/views/help/show.html.haml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/app/views/help/show.html.haml) 선택 사항입니다. 특정 ref가 포함된 전체 URL을 사용합니다. 예: [`app/views/help/show.html.haml`](https://gitlab.com/gitlab-org/gitlab/-/blob/6d01aa9f1cfcbdfa88edf9d003bd073f1a6fff1d/app/views/help/show.html.haml) 별도 리포지터리의 링크 # 다른 리포지터리에 있는 페이지로 링크하려면 전체 URL을 사용합니다. 예를 들어 GitLab 리포지터리의 페이지에서 Charts 리포지터리로 링크하려면 [GitLab Charts do