서랍 컨텐츠 생성

GitLab UI에서는 서랍 컴포넌트에 도움말 컨텐츠를 표시할 수 있습니다. Markdown을위한 컴포넌트는 storybook에 있습니다.

이 컴포넌트는 Markdown 파일을 가리킵니다. Markdown 파일을 업데이트하면 언제든지 서랍의 내용이 업데이트됩니다.

서랍 내용은 docs.gitlab.com에 표시되지 않고 서랍에만 렌더링됩니다. 콘텐츠는 GitLab Flavored Markdown으로 렌더링됩니다.

이 콘텐츠를 생성하려면 다음을 수행하세요:

  1. GitLab 리포지토리에서 /doc/drawers 폴더로 이동합니다.
  2. Markdown 파일을 만듭니다. 설명적인 파일 이름을 사용하십시오. 하위 폴더를 만들지 마십시오.

  3. 표준 페이지 메타데이터를 추가합니다. 또한 다음을 포함합니다: 

    type: drawer
  4. 콘텐츠를 작성합니다.

  5. 페이지에 docs.gitlab.com의 다른 페이지에도있는 콘텐츠가 포함된 경우 페이지의 메타데이터에 다른 파일로의 경로를 포함하십시오. 예: 

    source: /doc/user/search/global_search/advanced_search_syntax.md
  6. 개발자와 함께 작업하여 서랍에 콘텐츠가 올바르게 표시되는지 확인합니다.

서랍 콘텐츠 지침

  • 파일의 제목은 서랍의 제목으로 사용됩니다. H1 제목은 서랍 제목입니다.
  • H1에 일반 텍스트 이외의 문자를 포함하지 마십시오.
  • 서랍 컴포넌트는 좁고 크기를 조정할 수 없습니다.
    • 표를 포함하는 경우 내부 내용은 간결해야합니다.
    • 사용할 수있는 문자 수에 대한 기술적인 제한은 없지만 서랍 콘텐츠를 미리보기하여 렌더링이 잘되는지 확인해야합니다.
  • 서랍에서 다른 콘텐츠로 연결하려면 절대 URL을 사용하십시오.
  • 다음을 포함하지 마십시오:
    • 티어 배지
    • 히스토리 텍스트
    • 경고 상자
    • 이미지
    • SVG 아이콘