Stoplight Set Article Visibility

사내에서 추천을 받아 Stoplight를 탐구하고 있는 요즘이다.

사실 Postman이랑 Swagger도 잘 안 써봐서 처음엔 부담이었다.

게다가 Stoplight는 신세계(?)인지 심지어 유데미 인강도 없다.

(한국어 블로그 자료도 잘 없음)

다들 뭐 좋더라... 하고 끗..ㅋㅋ

 

일단은 Technical Writer에게 적합한 툴이라고 하니!

하나하나 유용한 기능들을 톺아보쟈 💪

 

You can now prevent articles from being visible to external users or users who are not members of a workspace. Internal articles are no longer visible in the Table of Contents or searchable for these users.
 
You may want to hide articles when:
- An article is in draft form. This is especially useful for web projects because it allows you to stage articles before making them public.
- An article contains internal notes that you want visible to workspace members, but not to public users. This is useful for linking to other articles and API elements in the same project without exposing your internal notes.

February 2022 Deployments | What's New?

 

1. Project Visibility에서 Public 프로젝트를 생성
2. docs에서 Test-external과 Test-internal md 파일 2개 생성
3. Test-internal만 internal 스위치 on 해줌
- TOC에 Test-internal md 파일 노출 안됨
- Search에서도 노출 안됨

 

internal 스위치를 파란색으로 켜는 순간 internal: true 태그가 생김

Test-internal md 목차에서 안보임

Test-internal md 검색에서도 안보임

이전 회사에서 새로운 문서 사이트를 셋업 했을 때

처음에 branch가 prod 환경 딱 하나만 있었음

개발자들이 아직 공개는 아니지만 작업중인 문서들도 branch에 작업하곤 했다.

첨엔 데브옵스 엔지니어 말마따나 TOC에선 주석 처리하면 목차에 노출 안 되는 줄 알았는데

검색에 다 나오고 것이었다 ㅠㅠ

 

결국 엔지니어가 dev 환경을 따로 만들어줬다.

dev branch는 작업용(?)이고

prod branch는 실제 문서가 노출되는 곳이다.

둘다 생긴 모양새는 똑같음

 

나중엔 prod branch에서 개발자들이 작업하다가 완성되면 -> dev branch로 merge하는 프로세스로 진행함

 

아무튼 요점은 TOC에서 노출안되도

검색에서도 작업 중인 문서가 노출되면 안 된다는 것이다..

꼼꼼하게 확인해야 함!!