Improve docs authoring experience

Đang mở
#519 5 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
30/100
Loại issue
Tính năng
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Lĩnh vực
documentation, tooling

Hướng nghiên cứu

Bắt đầu bằng việc xem xét extension Antora Atlas và extension partial build được liên kết trong issue, sau đó kiểm tra workflow build tài liệu hiện tại. Xác định việc caching UI bundle và partial build sẽ ảnh hưởng như thế nào đến thiết lập hai repository; công việc được xem là hoàn tất khi có một authoring workflow được tài liệu hóa, hoạt động được và có thời gian build ngắn hơn.

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

Mô tả

As a dev, writing docs is made unpleasant by a few things in the process, especially when writing docs for an Operator, because multiple repos are involved.

Currently the workflow is:

  • checkout both the docs repo and the operator repo
  • edit the playbook file to point to the local operator repo checkout
  • write the docs in the operator repo and rebuild the docs periodically

Main pain points are:

  • the setup is cumbersome
  • build times are long
### Tasks
- [ ] Cache UI bundle in the build
- [ ] investigate Atlas/partial build extension

Links:

Ngôn ngữ chính
CSS
Star
13
Fork
14
Merge trung bình
4 ngày 8 giờ
Pull request đã merge (30 ngày)
10

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

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

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

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

Issue tương tự

Thêm issue về Documentation

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.