Setup docs drift: docker-compose services not mentioned in README

Đã đóng Phù hợp với người mới
  • Có gì không ổn?
#7,775 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
1/5
Thời gian dự kiến
Dưới một giờ
Mức phù hợp với người mới
68/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
docker-compose
Lĩnh vực
devops, documentation

Hướng nghiên cứu

Bắt đầu với phần Setup trong README và so sánh phần này với các service được khai báo trong docker-compose.yml. Thêm lệnh docker compose up -d được ghi trong tài liệu và liệt kê bốn service được nêu trong issue; xác minh rằng các hướng dẫn sau đó bao quát việc khởi động cục bộ.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

Setup doc drift found

Running a scan that compares docker-compose.yml against README docs to find gaps that break local setup.

Finding — Services not documented docker-compose.yml defines 4 services (countly-api, countly-frontend, mongodb, nginx) but README has no mention of docker compose up. Engineer clones repo, follows docs, app fails to start — nothing is running.

Proposed patch — add to Setup section:

docker compose up -d

Services started: countly-api, countly-frontend, mongodb, nginx

Confidence: HIGH. Happy to open a PR if useful.

Ngôn ngữ chính
JavaScript
Star
5.9k
Fork
985
Merge trung bình
1 ngày 44 phút
Pull request đã merge (30 ngày)
109

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của Countly/countly-server

Tất cả issue của Countly/countly-server

Issue tương tự

Thêm issue về JavaScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.