Add "Warning/Tip" to top of older Release Notes that they might have outdated info

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

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

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
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

Hướng nghiên cứu

Xác định các Release Notes bao gồm bản phát hành cũ thứ năm và các bản phát hành trước đó, sau đó kiểm tra cách theme thể hiện tiêu đề cảnh báo. Áp dụng thông báo về thông tin lỗi thời được đề xuất cho các ghi chú đáp ứng điều kiện mà không viết lại nội dung lịch sử của chúng. Hoàn thành khi các ghi chú cũ hơn hiển thị cảnh báo một cách nhất quán, trong khi các Release Notes mới hơn vẫn không thay đổi.

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

Mô tả

As mentioned #536, search results can surface some pretty old Release Notes that have outdated info. A couple of options:

  1. Leave it as it is

  2. Review each release note and edit to highlight outdated info

  3. Just add a warning header (yellow formatting in the theme) to the top of older (say 5 releases back and older) release notes with something like (first pass):

    These are the Release Notes for <version>. If you have arrived here via Search, please keep in mind that information here may (or may not ) be outdated. Features may have been renamed, functionality added or removed, or other changes may have been made after this Release. Please refer to the other documentation sources on this site for updated information.

I'd vote for the third, personally. Regarding 2 - I think Release Notes are a historical archive and shouldn't be changed post de defacto. It would also be a major (and continual) undertaking to review and update.

While the first option is a possibility, the point made in #536 is a fair one that I'd like to see addressed in some way.

Ngôn ngữ chính
TypeScript
Star
258
Fork
561
Merge trung bình
3 giờ 20 phút
Pull request đã merge (30 ngày)
15

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

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

Tất cả issue của nushell/nushell.github.io

Issue tương tự

Thêm issue về TypeScript

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.