meaning of Summary

Đang mở
  • Có gì không ổn?
#616 8 bình luận 1 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ó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
43/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
python
Lĩnh vực
backend

Hướng nghiên cứu

Start by locating the document revision form, history view, and search configuration in the Odoo knowledge module; the issue does not name files or tests. Check how Name and Summary are used when editing a revision and displaying history, then define the expected behavior with maintainers before changing the UI. Done means revision changes require a fresh Changes value, history displays it, and document search defaults to the document Name.

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

Mô tả

Currently the field Summary is in section Revision so from this layout I understand that for each change users should give that change a Name and a Summary.

Image

The issues I see:

  • To describe a change two fields are unusual and IMO a single field would be sufficient
  • While editing the document content, both fields are not cleared so in practice you end up not updating those which renders the history useless (think of git would use a default commit message if you don't change it explicitly). This is the main issue I experience.
  • The history shows the Summary but not the Name. So what is the Name good for?
  • In the search for a document the default field is Summary. IMO this doesn't make sense if the Summary is specific per revision while the user is typically searching for a document
Image Image

I suggest the following solution:

  • Move Summary out of section Revision.
  • So we use Name for Revisions only and ideally rename that field to Changes
  • Show Name/Changes in the History instead of Summary
  • Change the UI so that user must enter a Name/Changes when changing a document revision and can not simply keep its content of the previous revision (likely an additional window)

What do you think?

Ngôn ngữ chính
HTML
Star
256
Fork
405
Không có pull request nào được merge trong 30 ngày

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 OCA/knowledge

Tất cả issue của OCA/knowledge

Issue tương tự

Thêm issue về Backend & API Design

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.