Skip to content

docs(confluence-mdx): README.md에 venv 활성화 필수 안내 추가#588

Merged
jk-kim0 merged 1 commit intomainfrom
docs/improve-venv-usage-guide
Jan 29, 2026
Merged

docs(confluence-mdx): README.md에 venv 활성화 필수 안내 추가#588
jk-kim0 merged 1 commit intomainfrom
docs/improve-venv-usage-guide

Conversation

@jk-kim0
Copy link
Copy Markdown
Contributor

@jk-kim0 jk-kim0 commented Jan 29, 2026

Summary

  • confluence-mdx/README.md의 "데이터 수집 및 변환 절차 상세 안내" 섹션에 venv 가상환경 활성화 필수 안내를 추가

변경 이유

기존 문서에서 스크립트 실행 예시(bin/pages_of_confluence.py 등)가 venv 활성화 없이 바로 실행되는 것처럼 보여, 다음과 같은 혼란이 발생할 수 있었습니다:

  1. 시스템 Python으로 실행 시도
  2. yaml, requests 등 필수 모듈 미설치 오류 발생
  3. venv 환경을 찾아서 활성화하는 데 불필요한 시간 소요

변경 내용

수정 파일: confluence-mdx/README.md

"데이터 수집 및 변환 절차 상세 안내" 섹션 상단에 다음 주의사항 추가:

> **주의:** 아래의 모든 스크립트 실행 예시는 **venv 가상환경이 활성화된 상태**에서 실행해야 합니다.
> ```bash
> cd querypie-docs/confluence-mdx
> source venv/bin/activate  # venv 활성화 필수
> ```

Test plan

  • README.md 마크다운 문법 확인
  • 안내 내용이 기존 "Python 가상환경(venv) 생성" 섹션과 일관성 확인

🤖 Generated with Claude Code

데이터 수집 및 변환 절차 상세 안내 섹션에서 스크립트 실행 시
venv 가상환경 활성화가 필요하다는 주의사항을 추가합니다.

기존 문서에서는 스크립트 실행 예시가 venv 활성화 없이 바로
실행되는 것처럼 보여, 시스템 Python으로 실행 시 모듈 미설치
오류가 발생할 수 있었습니다.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@vercel
Copy link
Copy Markdown

vercel Bot commented Jan 29, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Review Updated (UTC)
querypie-docs Ready Ready Preview, Comment Jan 29, 2026 4:47pm

Request Review

@jk-kim0 jk-kim0 self-assigned this Jan 29, 2026
@jk-kim0 jk-kim0 merged commit fbfe42e into main Jan 29, 2026
7 checks passed
@jk-kim0 jk-kim0 deleted the docs/improve-venv-usage-guide branch January 29, 2026 17:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants