Restructure docs directory

Đang mở
#1,849 3 bình luận 1 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
35/100
Loại issue
Tài liệu
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu bằng việc xem xét thư mục docs hiện có và issue liên quan #1848 để xác định các loại tài liệu hiện đang bị trộn lẫn. Xác định một cấu trúc phân biệt ADRs, nội dung Read the Docs và các tài liệu khác; công việc được xem là hoàn tất khi các danh mục được tách biệt rõ ràng và tài liệu hiện có vẫn được thống kê đầy đủ.

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

Mô tả

documentation low-prio

Description of issue or feature request:

Current behavior:
No clear distinction of different documentation types in docs directory.

Expected behavior:
Clear distinction of different documentation types in docs directory, e.g. along the following categories:

  • adr
  • rtd (e.g. see sphinx-quickstart dir scaffolding)
  • misc docs that are neither an adr, nor rendered on rtd (?)

related: see #1848

Ngôn ngữ chính
Python
Star
1.7k
Fork
304
Merge trung bình
1 ngày 2 giờ
Pull request đã merge (30 ngày)
17

Hướng dẫn đóng góp

Mở 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 theupdateframework/python-tuf

Tất cả issue của theupdateframework/python-tuf

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.