Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Document Unified Search behavior and administration

Abierto
  • ¿Algo no está bien?
#115 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
55/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Activo
Área
documentation

Línea de trabajo

Start with the four listed files: user_manual/functionality.rst, admin_manual/configuration.rst, and the two index.rst files, to learn the existing Sphinx structure and terminology. Confirm with maintainers which LibreSign backend and frontend changes are merged, since the text must match the implemented behavior, not the draft. Done when both user and admin sections are added and cross-linked, and make user and make admin build without errors.

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

Descripción

good first issue

Goal

Explain how LibreSign documents are discovered in Nextcloud Unified Search and how administrators configure that capability.

Starting points

  • user_manual/functionality.rst
  • admin_manual/configuration.rst
  • user_manual/index.rst
  • admin_manual/index.rst

Preserve existing Sphinx navigation and terminology.

User documentation

Explain:

  • How to search for LibreSign documents.
  • Who can find documents as owner, signer or observer.
  • How supported identity associations affect visibility.
  • How search results open the appropriate LibreSign workflow.
  • The difference between searching LibreSign documents and searching Nextcloud Files.
  • Limitations involving envelopes or external participants, as implemented.

Administrator documentation

Explain:

  • Where the Unified Search setting appears in Policy Workbench.
  • The default behavior.
  • System, group and account inheritance where applicable.
  • How to disable or enable provider availability.
  • Why disabling search does not revoke document access or change validation links.
  • Relevant operational limitations and troubleshooting guidance.

Acceptance criteria

  • Documentation matches the merged backend and frontend behavior.
  • User and administrator sections are discoverable.
  • Terminology and cross-links are consistent.
  • No internal storage paths, private data or credentials appear in examples.
  • Screenshots, if used, contain only synthetic data.
  • make user and make admin complete successfully.
  • Documentation CI passes.

Good first issue

This work is contained in the documentation repository. Begin with the listed .rst files and follow existing Sphinx formatting.

The issue can be drafted against the agreed behavior, but the final documentation must reflect the merged implementation.

Do not change the LibreSign application code or invent functionality that has not been implemented.

Additional context

Contributors are welcome to comment so maintainers can confirm that the referenced implementation is ready for documentation. This is not a prerequisite for contributing.

Community: https://t.me/libresign

Lenguaje dominante
Python
Estrellas
3
Forks
6
Merge medio
1 d 3 h
PR fusionados (30 d)
10

Preparar el entorno

  • Incluye un Dockerfile o un archivo de Docker Compose
  • Sin plantilla de pull request
  • Sin guía de contribución

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 LibreSign/documentation

Todos los issues de LibreSign/documentation

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.