Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Provide static, versioned documentation every time a new application release is created.

Đang mở
#215 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

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

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
35/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Lĩnh vực
documentation, release

Hướng nghiên cứu

Issue không nêu tên tệp hoặc test nào; hãy bắt đầu bằng việc xem xét quy trình build tài liệu và workflow release của repository, sau đó kiểm tra PR #212 được liên kết để tìm hiểu vấn đề versioning. Công việc được xem là hoàn tất khi mỗi application release mới đều tạo ra một bản sao tài liệu tĩnh, có version, mà không xảy ra nhầm lẫn giữa develop/release.

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

Mô tả

documentation enhancement

As the develop and release versions are now two distinct states, we also need to provide a static, versioned copy of the documentation for each release.

e.g. to eliminate issues like https://github.com/syslog-ng/syslog-ng.github.io/pull/212

Ngôn ngữ chính
JavaScript
Star
6
Fork
15
Merge trung bình
6 ngày 1 giờ
Pull request đã merge (30 ngày)
3

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

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

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 syslog-ng/syslog-ng.github.io

Tất cả issue của syslog-ng/syslog-ng.github.io

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.