![Docs as code - (5) docusaurus on-premise 댓글 기능 추가 with comentario](https://img1.daumcdn.net/thumb/R750x0/?scode=mtistory2&fname=https%3A%2F%2Fblog.kakaocdn.net%2Fdn%2FcOr3hG%2FbtsLSpN4JQK%2FkMtonc0jguSPuJHYc6t3F0%2Fimg.jpg)
Comentario 설정comentario 서비스를 실행하기 위해서 docker-compose 파일과 secrets.yaml 파일의 설정이 필요합니다. 1. docker-compose.yml 파일 작성version: '3'services: db: image: postgres:17-alpine environment: POSTGRES_DB: comentario POSTGRES_USER: postgres POSTGRES_PASSWORD: postgres ports: - "5432:5432" volumes: - postgres_data:/var/lib/postgresql/data networks: - shared-network ..
![Docs as code - (4) Docusaurus 방문자 확인 on-premise ackee analytics 적용기](https://img1.daumcdn.net/thumb/R750x0/?scode=mtistory2&fname=https%3A%2F%2Fblog.kakaocdn.net%2Fdn%2FeB8wOd%2FbtsLsABdtk7%2F9VCvzic9vwj9HboegkpCNK%2Fimg.jpg)
Docs as code - (1) Docusaurus v3의 on-premise analytics (matomo) 설정하기 (https 설정 추가) Docs as code - (1) Docusaurus v3의 on-premise analytics (matomo) 설정하기 (https 설정 추가)ADR 도입기 - (3) Docs as code 추가 기능 도입 (Local LLM으로 문서 번역, 문서 페이지 접속 데이터)우리 부서에 맞는 ADR (Architecture Decision Record) 템플릿 작성과 ADR 시스템 도입현재 우리 부서 상황에 맞는ray5273.tistory.com위의 포스트에서 matomo analytics를 적용을 해 보았습니다.정상 작동하는 것을 확인은 했으나 일단 matom..
![Docs as code - (3) Docusaurus 페이지에 대해 Typesense scraper로 검색 인덱스가 잘 생성되지 않는 문제 해결](https://img1.daumcdn.net/thumb/R750x0/?scode=mtistory2&fname=https%3A%2F%2Fblog.kakaocdn.net%2Fdn%2FcWtAps%2FbtsLrlLIsau%2FPVGEssvqEuMvqt70C3CvsK%2Fimg.png)
Docs as code - (2) Docusaurus v3의 On-premise 검색 엔진으로 Typesense 사용 하기 Docs as code - (2) Docusaurus v3의 On-premise 검색 엔진으로 Typesense 사용 하기실행 환경Windows 11 환경에서 실행되었습니다.또한 localhost (host.docker.internal) 환경에서 docusaurus와 typesense 서버를 실행합니다.docusaurus 버전은 3.5.2를 사용했습니다. 실행 방법 1. docusaurus.config.ts 파ray5273.tistory.com기존 포스트를 통해 Typesense를 사용하여 검색 인덱스를 생성 했었는데, 일부 문제가 있어서 해결하려고 합니다.Scraper를 통해서 i..
![Docs as code - (2) Docusaurus v3의 On-premise 검색 엔진으로 Typesense 사용 하기](https://img1.daumcdn.net/thumb/R750x0/?scode=mtistory2&fname=https%3A%2F%2Fblog.kakaocdn.net%2Fdn%2Fb9E6bk%2FbtsLdJzbomy%2F2W7Bhzi9pl7GgsMD1NiGe0%2Fimg.png)
실행 환경Windows 11 환경에서 실행되었습니다.또한 localhost (host.docker.internal) 환경에서 docusaurus와 typesense 서버를 실행합니다.docusaurus 버전은 3.5.2를 사용했습니다. 실행 방법 1. docusaurus.config.ts 파일을 변경합니다.1) url과 baseUrl을 변경합니다.어떻게 되어 있었든 localhost에서의 서버 실행을 위해서 아래와 같이 변경합니다.// Set the production url of your site here url: 'http://host.docker.internal', // Set the // pathname under which your site is served // For GitHub pag..
![Docs as code - (1) Docusaurus v3의 on-premise analytics (matomo) 설정하기 (https 설정 추가)](https://img1.daumcdn.net/thumb/R750x0/?scode=mtistory2&fname=https%3A%2F%2Fblog.kakaocdn.net%2Fdn%2FNPeAh%2FbtsK9miHpuD%2FjHmJHqxK0vUWX6OW0NI4oK%2Fimg.png)
ADR 도입기 - (3) Docs as code 추가 기능 도입 (Local LLM으로 문서 번역, 문서 페이지 접속 데이터)우리 부서에 맞는 ADR (Architecture Decision Record) 템플릿 작성과 ADR 시스템 도입현재 우리 부서 상황에 맞는 ADR 템플릿을 작성해 보려고 합니다.사실은 ADR이 무엇인지, ADR을 써야하는 이유는 무엇인ray5273.tistory.comAnalytics 관련 몇가지 자료를 더 찾아보다가 드디어 API를 사용하지 않고도 On-premise로 Docusaurus에 대해서 접속 정보를 확인할 수 있는 페이지를 찾았습니다. 여러모로 Docusaurus와의 연결성과 배포의 용이성을 판단 해 봤을때 대략 사용 가능한 후보는 두개정도 있었는데요.1. matom..
![Docusaurus Sidebar 제목에 prefix Icon 추가하기](https://img1.daumcdn.net/thumb/R750x0/?scode=mtistory2&fname=https%3A%2F%2Fblog.kakaocdn.net%2Fdn%2FI4Rgo%2FbtsJDgLXLVD%2FB932QZZ9nY9RsElRSZ7EOK%2Fimg.jpg)
Docusaurus 문서화를 하던 와중에 페이지의 직관성 및 가독성이 더 필요하다고 느끼게 되었습니다.그런 이유로 일부 기능을 더 보강하려고 합니다.그래서 가장 처음에 생각난 기능이 바로 Sidebar의 prefix에 icon을 추가해서 직관적으로 문서와 카테고리를 분류 하는 것입니다. 1. Custom CSS 추가 및 반영우선은 custom.css 파일을 적용하기 위해서아래와 같이 docusaurus.config.ts (혹은 js)에 custom.css 파일을 등록해 두어야합니다.presets: [ [ 'classic', { docs: { 중략... }, blog: { 중략... }, t..
![Docusaurus를 활용한 Doc as a code 및 Github Pages로 Deploy 해보기](https://img1.daumcdn.net/thumb/R750x0/?scode=mtistory2&fname=https%3A%2F%2Fblog.kakaocdn.net%2Fdn%2FbIIGNO%2FbtsIVbXBxi2%2F1TemQlXKVQAkpThhriITyK%2Fimg.jpg)
이전 포스트에서 우리 팀에서 원하는 기능에 대해서 동작하는지를 테스트 해보는 작업을 했습니다. Docusaurus를 사용한 Doc as a code Deploy 검토하기Doc as a code 요구사항Doc as a code Deploy를 위해서 요구사항을 기반으로 우리 부서에서 사용 가능한지 검토해보려고합니다.가장 최신버전인 Docusaurus v3.4.0를 기반으로 확인 해 보려고 합니다. 1. multi-ray5273.tistory.com 위의 테스트를 기반으로 실제 Deploy를 위한 작업을 했습니다.실제로 필요한 기능들을 사용 해 보면서 Github Pages로 Deploy할 수 있는 Template 코드를 작성했습니다. Tutorial Intro | Docusaurus TemplateLet's..
![Docusaurus를 사용한 Doc as a code Deploy 검토하기](https://img1.daumcdn.net/thumb/R750x0/?scode=mtistory2&fname=https%3A%2F%2Fblog.kakaocdn.net%2Fdn%2FcZSQWd%2FbtsIS6QXrix%2FLY9k2WwRlsUS3B4AHrl1P1%2Fimg.jpg)
Doc as a code 요구사항Doc as a code Deploy를 위해서 요구사항을 기반으로 우리 부서에서 사용 가능한지 검토해보려고합니다.가장 최신버전인 Docusaurus v3.4.0를 기반으로 확인 해 보려고 합니다. 1. multi-repository의 markdown 파일들에 대해서도 쉽게 indexing 제공각 폴더마다 _category_.json을 포함해야하는것으로 보입니다.{ "label": "Packer", "position": 2, "link": { "type": "generated-index", "description": "5 minutes to learn the most important Docusaurus concepts." }}이런 파일들을 추가하면 하위 ..
![ADR 도입기 - (2) Doc as a code의 Deploy, user guide와 SRS 관리 방법 검토](https://img1.daumcdn.net/thumb/R750x0/?scode=mtistory2&fname=https%3A%2F%2Fblog.kakaocdn.net%2Fdn%2FdCsTLb%2FbtsIUSRgUHM%2FvdUV3LuuPcwVTXnMJZE5Zk%2Fimg.png)
우리 부서에 맞는 ADR (Architecture Decision Record) 템플릿 작성과 ADR 시스템 도입현재 우리 부서 상황에 맞는 ADR 템플릿을 작성해 보려고 합니다.사실은 ADR이 무엇인지, ADR을 써야하는 이유는 무엇인지에 대해서 먼저 쓰고 싶었는데일단 부서내에서 ADR 사용에 대한 의견 제시ray5273.tistory.com ADR 도입기 (1) - ADR 도입에 대한 팀원들의 의견과 피드백이전 포스트에서 부서 내에 ADR을 도입하려는 계획과 설득을 위한 문서를 작성했었습니다. 우리 부서에 맞는 ADR (Architecture Decision Record) 템플릿 작성과 ADR 시스템 도입현재 우리 부서 상황에 맞ray5273.tistory.com이전 포스트에 이어서 3번째 글입니다..