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

Improve integration summaries

Đang mở
#339 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ó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
45/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Ít trao đổi
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu bằng cách xem lại các trang tích hợp hiện có cùng các quy tắc và định nghĩa của Vale được đề cập trong issue. So sánh giọng điệu, cấu trúc, các giả định và mức độ chi tiết thực tế của chúng, sau đó làm cho mỗi trang giải thích nhất quán về hoạt động tích hợp và các lợi ích của nó; công việc được xem là hoàn tất khi các trang tuân theo một cách tiếp cận chung mà không giả định người đọc đã có kiến thức trước đó.

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

Mô tả

The integration pages serve 2 purposes:

  1. Inform users what and how the integration works
  2. Sell the benefits of the inregration to potential new users reviewing the docs to see how it works.

Make each integration page:

  1. Use consistent style, tone, and language ( in addition to complying with all the Vale rules and definitions)
  2. Have a structiured approach to each page that begins by making no assumptions of what the integrations and what mission control is (besides for the main overview page) as you scroll down it becomes more practical
Ngôn ngữ chính
CSS
Star
1
Fork
2
Merge trung bình
2 ngày 14 giờ
Pull request đã merge (30 ngày)
2

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

Tất cả issue của flanksource/docs

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.