stackabletech / stackabletech/documentation
Explore alternatives to Antora for documentation
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- CSS
- Star
- 13
- Fork
- 14
- Merge trung bình
- 4 ngày 8 giờ
- Pull request đã merge (30 ngày)
- 10
Mô tả
[!IMPORTANT]
This issue is not a commitment to replacing Antora. It is just to record the frustrations of the current documentation workflow, look into alternatives, do timeboxed trials, and understand what we then lose by switching.
Acceptance
- List shortcomings of the status-quo (Antora)
- List things we like about the status-quo (Antora)
- Timeboxed trial of select alternatives to understand the tradeoffs
Hướng dẫn đóng góp
Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Không có tệp, bài kiểm thử hoặc điểm vào nào được nêu. Trước tiên, hãy ghi lại workflow tài liệu của Antora, tách riêng những điểm hạn chế khỏi những điểm mạnh của nó, sau đó tiến hành các thử nghiệm có giới hạn thời gian với những phương án thay thế được chọn và ghi lại các đánh đổi cũng như tổn thất của từng phương án.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Lĩnh vực
- documentation
- Loại issue
- Tái cấu trúc
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 25/100