DOCS: Restructure docs - Githubissues

naver / arcus-java-client

ARCUS Java client

Apache License 2.0

50 stars 47 forks source link

DOCS: Restructure docs #754

Closed namsic closed 5 months ago

namsic commented 6 months ago

🔗 Related Issue

jam2in/arcus-works#459

⌨️ What I did

docs 하위의 파일을 재배치합니다.
내용 수정 없이 위치만 이동합니다.
Gitbook 반영 시 아래와 같이 보여집니다.

변경 후 파일 구조 및 각 파일의 첫 line(헤더) 구성은 아래와 같습니다.

docs
├── arcus-java-client-getting-started.md (# 처음 사용자용 가이드)
└── user_guide
    ├── README.md (# ARCUS Java Client User Guide)
    ├── 01-arcus-cloud-basics.md (# ARCUS Cloud 기본 사항)
    ├── 02-arcus-java-client.md (# ARCUS Java Client)
    ...
    └── 12-arcus-future-get-API.md (# Future - get, getSome)

oliviarla commented 5 months ago

디렉토리명이 그대로 gitbook에 보여지는 대신, 속성 설정을 할 수 있는거죠?

namsic commented 5 months ago

@oliviarla 디렉토리명이 그대로 gitbook에 보여지는 대신, 속성 설정을 할 수 있는거죠?

현재 PR에서는 디렉토리명을 그대로 사용하지 않고 있습니다.
- 변경되는 구조를 PR 본문에 추가했으니, 참고 부탁드립니다.
- 만약 user_guide 하위에 README.md가 존재하지 않으면, 디렉토리명을 그대로 사용하게 됩니다. (상단 이미지에서 ARCUS Java Client User Guide 대신 user_guide로 보여지게 됩니다.)
속성 설정이 무엇을 의미하는지 잘 모르겠습니다.

oliviarla commented 5 months ago

README.md에 의해서 디렉토리가 구분되어 보이는거였군요. user-guide 라는 디렉토리가 그대로 보이지 않아 gitbook에서 import 속성 설정같은 것을 하는 줄 알았습니다.