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

Troubleshooting docs

Đang mở
  • Có gì không ổn?
#3,331 3 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ó
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
25/100
Loại issue
Tài liệu
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu bằng cách xem xét các chủ đề khắc phục sự cố hiện có và thứ tự ưu tiên theo khu vực chức năng của chúng, sau đó tham khảo L2 và L3 để tìm các kịch bản còn thiếu. Được coi là hoàn thành khi các khoảng trống liên quan đã được xác định và hướng dẫn khắc phục sự cố đã được cập nhật xoay quanh các triệu chứng của người dùng, thông báo lỗi và các giải pháp cụ thể thay vì các hạn chế chung.

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

Mô tả

epic

This epic is to track updates and doc bugs across the troubleshooting docs.

Notes from discussion with Alasdair:

Troubleshooting docs should take the approach of: "I'm doing x and getting this error. The solution is y." rather than just listing "limitations" or things that someone is just expected to remember. Troubleshooting docs, to be useful, need to be in a framing than enables the user to search/browse for something that describes the unfortunate situation that they're currently in. Then take their hand and make it all better. :)

The difference between troubleshooting and operations docs:

  • Troubleshooting Liberty is the kind of thing in this topic where you get a message and here's what to do about it.
  • Whereas, not analytics, logging, etc that we'd put in Operations.

Talk to L2 and L3:

  • Some of the tech docs online are troubleshooting "if you see x, then you need to do y".
  • talk to L2 and L3 to work out if there's things that we haven't covered that should be here

When prioritising troubleshooting work, follow the priority order of the functional areas of topics we've already got, in general.

Ngôn ngữ chính
Không có dữ liệu ngôn ngữ
Star
14
Fork
58
Merge trung bình
1 giờ 4 phút
Pull request đã merge (30 ngày)
21

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 OpenLiberty/docs

Tất cả issue của OpenLiberty/docs

Issue tương tự

Thêm issue về Documentation

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.