Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Document Unified Search behavior and administration

Aperta
  • Qualcosa non va?
#115 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
55/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Ambito
documentation

Direzione di ricerca

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.

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

Descrizione

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

Lingua principale
Python
Stelle
3
Fork
6
Merge medio
1g 3h
PR unite (30g)
10

Preparare l'ambiente

  • Include un Dockerfile o un file Docker Compose
  • Nessun modello di pull request
  • Nessuna guida per i contributori

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

Tutte le issue di LibreSign/documentation

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.