oracloud.kr 문서 작성

oracloud.kr의 문서 작성 절차를 정리합니다.

준비 사항

서비스 구성

서비스 구성
그림 1: 서비스 구성

Blog 문서 작성 및 배포 절차

oracloud.kr은 다음과 같은 절차로 작성합니다.

  1. oracloud-kr/oracloud_repo 레파지토리 fork
  2. repository clone
  3. 문서 작성
    • md 파일 작성 (blog)
    • 이미지 추가
      • commit & push
      • 이미지 배포
  4. 문서 작성 완료
    • blog repository 저장
      • commit & push
  5. pull request
    • github site
  6. 그룹 관리자에게 통보
    • Security: JC.H
    • PaaS: MN.L
    • IaaS: IH.K
    • Data Analysis: TW.K
  7. 그룹 관리자는 문서 점검 후 merge
  8. 5분후 문서 갱신 확인

1. blog 레파지토리 fork

blog repsitory를 fork합니다.

블로그 레파지토리 Fork
그림 2: 블로그 레파지토리 Fork

2. repository clone

> git clone https://github.com/taewanme/oracloud_repo 
> git clone git@github.com:oracloud-kr-teamrepo/oracloud-kr-teamrepo.github.io.git images

3. 문서 작성 & 이미지 수정

  • 문서 작성
  • images 디렉터리에 이미지 추가
    • 이미지 명명 규칙
      • 디렉터리 명
        • {year}/[month]/{title}
        • tile에 특수문자로 “_” 만 허용
        • 파일명: “.“을 제외한 특수분자를 사용할 수 없음
이미지 파일 명명 규칙
그림 3: 이미지 파일 명명 규칙
  • image 파일 배포
    • 이미지 파일은 직접 배포로 함
    • github에 push하는 것으로 배포 완료
    • 적용시간: 1min
cd images
git add *
git commit -m "add images for '{title}'"
git push origin master
  • 작업 문서 점검 방법
> cd oracloud_repo
> hugo server

5. MD 파일 메타 정보

markdown 파일의 상단에는 다음과 같은

4. 문서 작성 완료

  • markdown 파일 github에 push
cd oracloud_repo
git add *
git commit -m "add article for '{title}'"
git push origin master

5. pull request

pull request는 github 사이트에서도 요청할 수 있습니다.

UI에서 Pull Request 생성
그림 4: UI에서 Pull Request 생성
Pull Request 생성 요청
그림 5: Pull Request 생성 요청
Pull request 주석
그림 6: Pull request 주석
Pull Request 생성
그림 7: Pull Request 생성
Pull Request 생성 결과 확인
그림 8: Pull Request 생성 결과 확인

6. 그룹 관리자에게 통보

Pull Request가 생성되면 각 그룹리더에게 Pull Request를 통지합니다.

7. 관리자는 문서 점검 후 merge

  • 문서의 내용 및 의도를 파악하고 Pull Request의 Merge 여부 결정 및 수정 요청

이미지 작업시 유의 사항

1. 이미지 저장소 일원화

문서에 포함되는 모든 문서는” oracloud-kr-teamrepo/oracloud-kr-teamrepo.github.io”에 저장해 주시기 바랍니다.

외부에 공개된 이미지를 이용하더라도 대상 이미지를 다운로드 받아 “oracloud-kr-teamrepo/oracloud-kr-teamrepo.github.io”에 추가해 주시기 바랍니다.

2. 이미지 사이즈

이미지 크기가 너무 크면 문서가 출력되는 과정에서 브라우저 렌더링이 늦어지는 불편함을 일으킵니다. 따라서 다름과 같은 규칙을 정하겠습니다.

  • main 페이지 목록의 Thumbnail 이미지
    • width: 폭 204 pixel
    • height: 250 ~ 330 pixel
    • 파일 사이즈: 50kbyte 이하
    • 파일 포멧: jpg or png
  • 문서에 포함 이미지
    • width: 1300 pixel 이하
    • 이미지 사이즈: 150kbyte 이하를 권장 (최대: 200 kbte)
    • 파일 포멧: jpg or png
  • 저자 이미지
    • 파일 형식: jpg or png
    • 이미지 크기: 200 X 200

3. 이미지 저자권

oracloud.kr은 기업의 기술을 지원하는 서비스다 보니 저작권에 주의해야 합니다. oracle.com의 이미지를 사용할 경우 문제는 없겠지만 다른 경쟁사의 이미지 혹은 외부에서 이미지를 참조하거나 가져다 사용할 경우 저작권 문제를 고민해 주셔야 합니다. 현재 개인 콘텐츠도 저작권이 인정되는 상태입니다. 따라서 가능한 저작권 문제가 없는 이미지를 사용해 주시기 바랍니다.

저작권 문제를 해결한 서비스(사이트, http://littlevisuals.co/) 들이 많습니다. 이미지 사용시 참조해 주시기 바랍니다. 가능한 다음과 같은 가이드를 부탁드립니다.

  1. oracle.com에서 공개한 이미지를 사용
  2. 외부 이미지 사용 시 저작권 문제가 없는 이미지 사용
  3. 애매할 경우 이미지를 직접 작성(ppt 등으로)
  4. 외부 인용 시 출처 명시

4. 외부 이미지 사용시 주의 사항

저자권에 문제가 없는 외부에 공개된 이미지를 이용하더라도 대상 이미지를 다운로드 받아 “oracloud-kr-teamrepo/oracloud-kr-teamrepo.github.io”에 추가해 주시기 바랍니다.

해당 이미지는 문서 인용시 출처를 면시해 주시기 바랍니다.

문서 작성시 Tip

이미지 명명 규칙

이미지를 추가할 때 다음과 같은 명명 규칙을 준수하여 주시기 바랍니다.

  • 이미지 명명 규칙
    • 디렉터리 명
      • {year}/[month]/{title}
      • tile에 특수문자로 “_” 만 허용
      • 파일명: “.“을 제외한 특수분자를 사용할 수 없음

이미지 배포 시간은 약 1분이내 입니다.

브라우저 캐싱 off

브라우저 캐싱을 비활성화 시키시면 작업이 편리합니다. 이미지 배포가 늦게 느껴지는 이유는 브라우저 캐싱 때문에 인식하지 못하는 이유입니다.

크롬은 다음과 같은 절차로 브라우저의 캐쉬를 비활성화 할 수 있습니다.

크롬 개발자 툴
그림 9: 크롬 개발자 툴
크롬 캐쉬 비활성화
그림 10: 크롬 캐쉬 비활성화

메타정보 Mapping

+++
date = "2018-09-09T01:09:25+09:00"
description = "Oracle OCI"
title = "'Key Concepts and Terminology"
thumbnailInList = "https://taewanmerepo.github.io/2017/12/trans-shell/head.jpg"
thumbnailInPost = "https://taewanmerepo.github.io/2017/12/trans-shell/head.jpg"
tags = ["Oracle", "Cloud", "OCI"]
categories = ["cloud"]
author = "taewan.kim"
language = ""
adsense = "true"
+++
  • date

  • description

    • 구글 검색 최적화
      • tags
      • categories
    • Facebook 노출
구글 검색 최적화
그림 11: 구글 검색 최적화
facebook 링크시 요약 글
그림 12: facebook 링크시 요약 글
  • thumbnailInList (생략 불가)

    • 문서 목록 이미지
  • thumbnailInPost (생략 가능, 사용 권장)

    • 문서의 상단 이미지
  • author

    • mail: id 사용
저자 서명
그림 13: 저자 서명

문서 배포가 끝나면: 문서 홍보

oracloud.kr에 문서를 작성해 주시면, 해당 문서에 대한 홍보를 부탁드립니다. 여기서 홍보란 페이스 북의 “오라클 클라우드 사용자 그룹”에 문서에 대한 소개를 해주시는 것 입니다. 현재 오라클 클라우드 사용자 그룹에 문서 주소와 취지를 간략하게 정리하여 글을 등록하여 주십시요.

  • oracloud.kr: 컨텐츠 퍼블리싱 툴
  • 페이스북 오라클 클라우드 사용자 그룹: 커뮤니케이션 인터페이스
페이스북 오라클 클라우드 사용자 그룹에 등록
그림 14: 페이스북 오라클 클라우드 사용자 그룹에 등록

참고 URL