meaning of Summary

Aperta
#616 8 commenti 1 reazione 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
43/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
python
Ambito
backend

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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?

Lingua principale
HTML
Stelle
256
Fork
405
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di OCA/knowledge

Tutte le issue di OCA/knowledge

Issue simili

Altre issue su Backend & API Design

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.