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

Create managed files for pulp-docs on ALL components

Đang mở
  • Có gì không ổn?
#183 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

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

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tính năng
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Công nghệ
github-actions
Lĩnh vực
ci-cd, documentation, tooling

Hướng nghiên cứu

Start by reviewing pulp_template and the reusable GitHub workflow already mentioned for component docs CI. Define how non-plugin components opt in and how managed files are distributed across all components. Done should include compliance checks and auto-fixes plus canonical docs build, serve, and lint commands.

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

Mô tả

epic

Because there isn't an integrated system for distributing doc-related changes, modifying something in the docs infrastructure is painful and error-prone, which makes the development of pulp-docs brittle.

Generally we could use https://github.com/pulp/pulp_template for managing all plugin templates, but that doesn't apply to components (pulp-docs components) which are not plugins, for example, pulp-docs itself, pulp-cli, pulp-oci-images, etc. Probably we could extend it to all components, and non-plugins would opt-in only for docs. This is my prefered implementation approach.

I've started creating a re-usable github workflow for managing the component's docs CI, but it's not enough.
Some features that this would enable (and are important for future development) are:

  • Checks and auto-fixes of compliance with new infrastructure change (e.g, folder names, a new docs config, formatting, etc)
  • Managing a docs command runner (make docs-build/serve, ...) for canonical ways of build, serving and linting plugin-specific documentation.
Ngôn ngữ chính
HTML
Star
2
Fork
17
Merge trung bình
1 giờ 8 phút
Pull request đã merge (30 ngày)
1

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

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 pulp/pulp-docs

Tất cả issue của pulp/pulp-docs

Issue tương tự

Thêm issue về DevOps

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.