Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Document Unified Search behavior and administration

Đang mở
  • Có gì không ổn?
#115 0 bình luận 0 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ó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
55/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Lĩnh vực
documentation

Hướng nghiên cứu

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.

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

Mô tả

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

Ngôn ngữ chính
Python
Star
3
Fork
6
Merge trung bình
1 ngày 3 giờ
Pull request đã merge (30 ngày)
10

Chuẩn bị môi trường

  • Có Dockerfile hoặc tệp Docker Compose
  • Không có mẫu pull request
  • Không có hướng dẫn đóng góp

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

Tất cả issue của LibreSign/documentation

Issue tương tự

Thêm issue về Python

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.