meaning of Summary

Abierto
  • ¿Algo no está bien?
#616 8 comentarios 1 reacción 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
43/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Tranquilo
Stack tecnológico
python
Área
backend

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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?

Lenguaje dominante
HTML
Estrellas
256
Forks
405
Sin PR fusionados en 30 d

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de OCA/knowledge

Todos los issues de OCA/knowledge

Issues similares

Más issues de Backend & API Design

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.