InfoGrab DocsInfoGrab Docs

UI 요소와 탐색 경로

요약

문서에서 UI를 언급할 때는 다음을 지켜야 합니다. 사용자 인터페이스 텍스트에 스타일 오류가 있다고 생각되면 이슈나 MR을 만들어 사용자 인터페이스 텍스트의 변경을 제안합니다. ui 및 external-ui 숏코드는 텍스트를 UI 요소로 표시합니다.

문서에서 UI를 언급할 때는 다음을 지켜야 합니다.

  • 숏코드를 사용해 해당 텍스트를 UI 텍스트로 표시합니다.
  • 대소문자를 포함해 UI 텍스트와 정확히 일치시킵니다. 유일한 예외는 외부 도구의 UI 텍스트가 모두 대문자인 경우입니다(예: RECENT FLOWS). 이 경우에는 문장형 대소문자(sentence case)를 사용합니다.

UI 요소에는 다음이 포함됩니다.

  • 버튼
  • 체크박스
  • 설정
  • 메뉴
  • 페이지
  • 탭

사용자 인터페이스 텍스트에 스타일 오류가 있다고 생각되면 이슈나 MR을 만들어 사용자 인터페이스 텍스트의 변경을 제안합니다.

UI 텍스트 표시#

ui 및 external-ui 숏코드는 텍스트를 UI 요소로 표시합니다. 둘 다 docs.gitlab.com과 GitLab /help에서 굵게 렌더링됩니다.

UI 요소를 표시하려면 다음 숏코드 중 하나를 사용합니다.

  • GitLab에는 ui를 사용합니다.
    • locale/gitlab.pot 파일에서 문자열을 복사합니다. 문자열에 네임스페이스가 있으면 함께 포함합니다.
    • gitlab.pot에 문자열이 없다면 문서와 UI가 동기화되지 않았거나 UI 텍스트가 하드코딩된 것입니다. 올바른 문자열을 찾아 문서를 업데이트하거나, 하드코딩된 문자열에는 굵게 표시를 사용합니다.
    • 문자열이 줄임표(... 또는 …)로 끝나면 숏코드에 줄임표를 포함하지 않습니다.
  • GitLab이 아닌 제품에는 external-ui를 사용합니다. 다른 제품의 UI 문자열과 최대한 가깝게 일치시킵니다.

다음 예시에는 하드코딩된 문자열이 포함되어 있습니다.

1. In the left sidebar, select  > .
1. Select the  checkbox.
1. Select **Jenkins**.

외부 UI 예시:

1. On your Jenkins instance, select .

네임스페이스가 있는 예시:

1. In the right sidebar, in the  section, select .

CI/CD job은 모든 ui 문자열을 locale/gitlab.pot와 대조합니다. 문서화된 UI 문자열을 gitlab.pot 파일에서 찾을 수 없으면 job이 실패합니다. 이 job은 external-ui 문자열을 무시합니다.

네임스페이스#

UI 텍스트 문자열에 네임스페이스가 있으면 숏코드에 반드시 포함해야 합니다.

일부 문자열은 gitlab.pot 파일에 네임스페이스가 서로 다르거나 없는 상태로 여러 번 나타납니다. 네임스페이스가 여러 개인지 확인하고, 문서에서 언급하는 UI 영역과 일치하는 것을 사용합니다.

네임스페이스는 페이지를 렌더링할 때 표시되지 않습니다. 예를 들면 다음과 같습니다.

  • gitlab.pot 파일: msgid "Job|Cancel"
  • 숏코드:
  • 렌더링 결과:

표에서는 파이프가 표 셀을 나누지 않도록 파이프를 백슬래시(\|)로 이스케이프합니다. 예: .

탐색#

GitLab UI를 탐색하는 방법을 문서화할 때는 다음을 따릅니다.

  • 항상 위치를 먼저 쓰고 동작을 씁니다.
    • From the dropdown list (location), select (action).
  • 간결하고 구체적으로 씁니다. 예:
    • 권장: Select .
    • 비권장: Select for the changes to take effect.
  • 단계에 이유를 포함해야 한다면 이유로 단계를 시작합니다. 사용자가 더 빠르게 훑어볼 수 있습니다.
    • 권장: To view the changes, in the merge request, select the link.
    • 비권장: Select the link in the merge request to view the changes.

UI 요소 이름#

GitLab UI에서는 다음 이름을 사용합니다.

일반적인 GitLab 애플리케이션 페이지 구성의 와이어프레임입니다.

  1. Top bar
  2. Left sidebar: 사용자 인터페이스 왼쪽에 있는 탐색 사이드바입니다.
    • the Explore menu 또는 the Your work sidebar라는 표현을 사용하지 않습니다. 대신 the left sidebar를 사용합니다.
  3. ... panel: 기본 컨텍스트를 기준으로 합니다. 예를 들어 컨텍스트가 머지 리퀘스트이면 merge request panel이라고 부릅니다.
  4. Details panel: 기본 컨텍스트를 보조합니다. 선택한 이슈나 에픽에 한정됩니다.
  5. GitLab Duo panel
  6. GitLab Duo sidebar

right sidebar는 사용자 인터페이스 오른쪽에 있는 탐색 사이드바이며, 열려 있는 이슈, 머지 리퀘스트, 에픽에 한정됩니다.

GitLab Duo를 제외하고 위의 모든 용어는 소문자로 씁니다.

개별 UI 요소에 대한 추가 지침은 단어 목록에 있습니다.

탐색 작업 단계 작성 방법#

일관성을 유지하기 위해 작업 주제에서 탐색 단계를 쓸 때는 다음 예시를 사용합니다. 기본으로 고정된 항목을 포함해 다른 단계가 있을 수 있지만 다음 단계를 대신 사용합니다.

프로젝트 설정을 여는 방법:

1. In the top bar, select  and find your project.
1. In the left sidebar, select  > .
1. Expand .

그룹 설정을 여는 방법:

1. In the top bar, select  and find your group.
1. In the left sidebar, select  > .
1. Expand .

최상위 그룹의 설정을 여는 방법:

1. In the top bar, select  and find your group.
   This group must be at the top level.
1. In the left sidebar, select  > .
1. Expand .

프로젝트 또는 그룹 설정 중 하나를 여는 방법:

1. In the top bar, select  and find your project or group.
1. In the left sidebar, select  > .
1. Expand .

프로젝트를 만드는 방법:

1. In the upper-right corner, select  () and .

그룹을 만드는 방법:

1. In the upper-right corner, select  () and .

Admin 영역을 여는 방법:

1. In the upper-right corner, select .
1. In the left sidebar, select  > .

Your work 메뉴 항목을 여는 방법:

1. In the top bar, select .
1. Select .

아바타를 선택하는 방법:

1. In the upper-right corner, select your avatar.

일부 드롭다운 목록에서 선택 항목을 저장하는 방법:

1. Go to your issue.
1. In the right sidebar, in the  section, select .
1. From the dropdown list, select the iteration to associate this issue with.
1. Select any area outside the dropdown list.

내 모든 프로젝트를 보는 방법:

1. In the top bar, select .
1. Select .

내 모든 그룹을 보는 방법:

1. In the top bar, select .
1. Select .

선택 단계#

단계가 선택 사항이면 Optional이라는 단어 뒤에 마침표를 붙여 단계를 시작합니다.

예:

1. Optional. Enter a description for the job.

권장 단계#

단계가 권장 사항이면 Recommended라는 단어 뒤에 마침표를 붙여 단계를 시작합니다.

예:

1. Recommended. Enter a description for the job.

키보드 단축키와 명령 문서화#

두 가지 방법이 모두 있을 때는 키보드 명령 대신 UI 지침을 씁니다. 이 지침은 GitLab과 VS Code 같은 서드파티 애플리케이션에 모두 적용됩니다.

GitLab의 키보드 명령은 GitLab 키보드 단축키에 문서화되어 있습니다.

한 단계에서 여러 필드 문서화#

UI 텍스트가 섹션의 필드를 충분히 설명한다면 필드마다 작업 단계를 넣지 않습니다. 대신 여러 필드를 하나의 작업 단계로 요약합니다.

Complete the fields라는 문구를 사용합니다.

예:

1. In the top bar, select  and find your project.
1. In the left sidebar, select  > .
1. Expand .
1. Complete the fields.

여러 필드를 문서화하면서 필드 하나만 설명이 필요하다면 같은 단계에서 설명합니다.

1. Expand .
1. Complete the fields.  must be a regular expression.

여러 필드를 설명하려면 순서 없는 목록 항목을 사용합니다.

1. Select .
1. Complete the fields.
   - : Select one of the preconfigured
     intervals, or enter a custom interval.
   - : Add any number of CI/CD variables to the schedule.

UI 요소와 탐색 경로

GitLab v19.6
원문 보기

요약

문서에서 UI를 언급할 때는 다음을 지켜야 합니다. 사용자 인터페이스 텍스트에 스타일 오류가 있다고 생각되면 이슈나 MR을 만들어 사용자 인터페이스 텍스트의 변경을 제안합니다. ui 및 external-ui 숏코드는 텍스트를 UI 요소로 표시합니다.

문서에서 UI를 언급할 때는 다음을 지켜야 합니다.

  • 숏코드를 사용해 해당 텍스트를 UI 텍스트로 표시합니다.
  • 대소문자를 포함해 UI 텍스트와 정확히 일치시킵니다. 유일한 예외는 외부 도구의 UI 텍스트가 모두 대문자인 경우입니다(예: RECENT FLOWS). 이 경우에는 문장형 대소문자(sentence case)를 사용합니다.

UI 요소에는 다음이 포함됩니다.

  • 버튼
  • 체크박스
  • 설정
  • 메뉴
  • 페이지
  • 탭

사용자 인터페이스 텍스트에 스타일 오류가 있다고 생각되면 이슈나 MR을 만들어 사용자 인터페이스 텍스트의 변경을 제안합니다.

UI 텍스트 표시#

ui 및 external-ui 숏코드는 텍스트를 UI 요소로 표시합니다. 둘 다 docs.gitlab.com과 GitLab /help에서 굵게 렌더링됩니다.

UI 요소를 표시하려면 다음 숏코드 중 하나를 사용합니다.

  • GitLab에는 ui를 사용합니다.
    • locale/gitlab.pot 파일에서 문자열을 복사합니다. 문자열에 네임스페이스가 있으면 함께 포함합니다.
    • gitlab.pot에 문자열이 없다면 문서와 UI가 동기화되지 않았거나 UI 텍스트가 하드코딩된 것입니다. 올바른 문자열을 찾아 문서를 업데이트하거나, 하드코딩된 문자열에는 굵게 표시를 사용합니다.
    • 문자열이 줄임표(... 또는 …)로 끝나면 숏코드에 줄임표를 포함하지 않습니다.
  • GitLab이 아닌 제품에는 external-ui를 사용합니다. 다른 제품의 UI 문자열과 최대한 가깝게 일치시킵니다.

다음 예시에는 하드코딩된 문자열이 포함되어 있습니다.

1. In the left sidebar, select  > .
1. Select the  checkbox.
1. Select **Jenkins**.

외부 UI 예시:

1. On your Jenkins instance, select .

네임스페이스가 있는 예시:

1. In the right sidebar, in the  section, select .

CI/CD job은 모든 ui 문자열을 locale/gitlab.pot와 대조합니다. 문서화된 UI 문자열을 gitlab.pot 파일에서 찾을 수 없으면 job이 실패합니다. 이 job은 external-ui 문자열을 무시합니다.

네임스페이스#

UI 텍스트 문자열에 네임스페이스가 있으면 숏코드에 반드시 포함해야 합니다.

일부 문자열은 gitlab.pot 파일에 네임스페이스가 서로 다르거나 없는 상태로 여러 번 나타납니다. 네임스페이스가 여러 개인지 확인하고, 문서에서 언급하는 UI 영역과 일치하는 것을 사용합니다.

네임스페이스는 페이지를 렌더링할 때 표시되지 않습니다. 예를 들면 다음과 같습니다.

  • gitlab.pot 파일: msgid "Job|Cancel"
  • 숏코드:
  • 렌더링 결과:

표에서는 파이프가 표 셀을 나누지 않도록 파이프를 백슬래시(\|)로 이스케이프합니다. 예: .

탐색#

GitLab UI를 탐색하는 방법을 문서화할 때는 다음을 따릅니다.

  • 항상 위치를 먼저 쓰고 동작을 씁니다.
    • From the dropdown list (location), select (action).
  • 간결하고 구체적으로 씁니다. 예:
    • 권장: Select .
    • 비권장: Select for the changes to take effect.
  • 단계에 이유를 포함해야 한다면 이유로 단계를 시작합니다. 사용자가 더 빠르게 훑어볼 수 있습니다.
    • 권장: To view the changes, in the merge request, select the link.
    • 비권장: Select the link in the merge request to view the changes.

UI 요소 이름#

GitLab UI에서는 다음 이름을 사용합니다.

일반적인 GitLab 애플리케이션 페이지 구성의 와이어프레임입니다.

  1. Top bar
  2. Left sidebar: 사용자 인터페이스 왼쪽에 있는 탐색 사이드바입니다.
    • the Explore menu 또는 the Your work sidebar라는 표현을 사용하지 않습니다. 대신 the left sidebar를 사용합니다.
  3. ... panel: 기본 컨텍스트를 기준으로 합니다. 예를 들어 컨텍스트가 머지 리퀘스트이면 merge request panel이라고 부릅니다.
  4. Details panel: 기본 컨텍스트를 보조합니다. 선택한 이슈나 에픽에 한정됩니다.
  5. GitLab Duo panel
  6. GitLab Duo sidebar

right sidebar는 사용자 인터페이스 오른쪽에 있는 탐색 사이드바이며, 열려 있는 이슈, 머지 리퀘스트, 에픽에 한정됩니다.

GitLab Duo를 제외하고 위의 모든 용어는 소문자로 씁니다.

개별 UI 요소에 대한 추가 지침은 단어 목록에 있습니다.

탐색 작업 단계 작성 방법#

일관성을 유지하기 위해 작업 주제에서 탐색 단계를 쓸 때는 다음 예시를 사용합니다. 기본으로 고정된 항목을 포함해 다른 단계가 있을 수 있지만 다음 단계를 대신 사용합니다.

프로젝트 설정을 여는 방법:

1. In the top bar, select  and find your project.
1. In the left sidebar, select  > .
1. Expand .

그룹 설정을 여는 방법:

1. In the top bar, select  and find your group.
1. In the left sidebar, select  > .
1. Expand .

최상위 그룹의 설정을 여는 방법:

1. In the top bar, select  and find your group.
   This group must be at the top level.
1. In the left sidebar, select  > .
1. Expand .

프로젝트 또는 그룹 설정 중 하나를 여는 방법:

1. In the top bar, select  and find your project or group.
1. In the left sidebar, select  > .
1. Expand .

프로젝트를 만드는 방법:

1. In the upper-right corner, select  () and .

그룹을 만드는 방법:

1. In the upper-right corner, select  () and .

Admin 영역을 여는 방법:

1. In the upper-right corner, select .
1. In the left sidebar, select  > .

Your work 메뉴 항목을 여는 방법:

1. In the top bar, select .
1. Select .

아바타를 선택하는 방법:

1. In the upper-right corner, select your avatar.

일부 드롭다운 목록에서 선택 항목을 저장하는 방법:

1. Go to your issue.
1. In the right sidebar, in the  section, select .
1. From the dropdown list, select the iteration to associate this issue with.
1. Select any area outside the dropdown list.

내 모든 프로젝트를 보는 방법:

1. In the top bar, select .
1. Select .

내 모든 그룹을 보는 방법:

1. In the top bar, select .
1. Select .

선택 단계#

단계가 선택 사항이면 Optional이라는 단어 뒤에 마침표를 붙여 단계를 시작합니다.

예:

1. Optional. Enter a description for the job.

권장 단계#

단계가 권장 사항이면 Recommended라는 단어 뒤에 마침표를 붙여 단계를 시작합니다.

예:

1. Recommended. Enter a description for the job.

키보드 단축키와 명령 문서화#

두 가지 방법이 모두 있을 때는 키보드 명령 대신 UI 지침을 씁니다. 이 지침은 GitLab과 VS Code 같은 서드파티 애플리케이션에 모두 적용됩니다.

GitLab의 키보드 명령은 GitLab 키보드 단축키에 문서화되어 있습니다.

한 단계에서 여러 필드 문서화#

UI 텍스트가 섹션의 필드를 충분히 설명한다면 필드마다 작업 단계를 넣지 않습니다. 대신 여러 필드를 하나의 작업 단계로 요약합니다.

Complete the fields라는 문구를 사용합니다.

예:

1. In the top bar, select  and find your project.
1. In the left sidebar, select  > .
1. Expand .
1. Complete the fields.

여러 필드를 문서화하면서 필드 하나만 설명이 필요하다면 같은 단계에서 설명합니다.

1. Expand .
1. Complete the fields.  must be a regular expression.

여러 필드를 설명하려면 순서 없는 목록 항목을 사용합니다.

1. Select .
1. Complete the fields.
   - : Select one of the preconfigured
     intervals, or enter a custom interval.
   - : Add any number of CI/CD variables to the schedule.