SK텔레콤 오픈소스 포털 웹사이트에서는 SK텔레콤 오픈소스 가이드를 공개하고 있습니다. 아래 절차를 참고핳여 이 내용을 수정하거나 새로운 내용을 추가할 수 있습니다.
- GitHub workflow의 Step 1~4를 수행하여 SK텔레콤 오픈소스 포털 웹사이트의 소스 코드를 로컬 PC에 다운로드합니다.
블로그의 소스 코드는 다음 디렉토리에 위치합니다.
$ cd content/ko/guide/
$ ls
_index.md contribute ospo.png release use
/use: 오픈소스 사용 가이드/contribute: 오픈소스 기여 가이드/release: 오픈소스 공개 가이드
content/ko/guide/ 디렉토리 내에 수정 혹은 추가하고자 하는 디렉토리에서 _index.md 파일을 기반으로 작성합니다. 예를 들어, 오픈소스 사용하기 페이지를 수정하려고 한다면, 다음 _index.md 파일을 수정해야 합니다.
$ cd ./guide/use
$ ls _index.md check choose license obligation
$ vi _index.md
_index.md 파일은 Markdown 형태이며 상단의 헤더 영역과 본문 영역으로 구분되며, 헤더 영역은 다음과 같이 구성됩니다,
---
title: "오픈소스 사용하기"
linkTitle: "사용하기"
weight: 10
type: docs
description: >
오픈소스 올바르게 사용하기
---
각 항목의 내용은 다음과 같습니다.
- title : 문서의 제목이며, 웹사이트 화면 상단의 Title 영역에 표시됩니다.
- linkTitle : 메뉴 이름으며, 웹사이트 좌측의 메뉴바 영역에 표시됩니다. (작성하지 않을 경우, title 값이 메뉴바에 표시됩니다.)
- weight: weight 값에 따라 화면 좌측메뉴 영역에 보여질 순서가 정해집니다.
- type : docs -> 이 부분은 수정하지 마세요. type은 docs로 되어 있어야 합니다.
- description: 문서에 대한 간략한 소개이며 웹사이트 화면 상단의 Title 영역 바로 아래에 표시됩니다.
필요할 경우 헤더 영역을 편집한 후 문서 본문을 Markdown 문법에 맞추어 작성합니다. 필요에 따라 파일과 그림을 첨부합니다. : 파일 첨부와 그림 보여주기
수정 사항을 작성 후 로컬에서 웹사이트 구동하기를 해보면 수정 사항이 정상적으로 동작하는지 확인할 수 있습니다.
국문 페이지 내용 작성을 완료하였으면 다음 안내에 따라 이를 영문 페이지에도 반영하세요. : 영문 페이지 작성 방법
(영문 페이지에 반영할 필요가 없는 내용일 경우, 영문 페이지 반영하기는 스킵합니다.)
추가 / 수정을 완료하면 Pull Request하여 반영을 요청합니다. 관리자가 Review후 Merge / Deploy합니다. Git Workflow를 참고하여 Pull Request를 보내주세요.