[DOCS] EOL Policy

Đang mở
#28 0 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ó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
42/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Lĩnh vực
documentation

Hướng nghiên cứu

Start by reviewing hardware-software.md and the support page linked in the issue to see how requirements, versioning, and changelogs are currently documented. Write an explicit EOL policy guide from the policy details in the issue, and consider whether a support matrix is needed. Done means the guide clearly documents deprecation notice, fixes, breaking changes, connector support, and manual support timelines.

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

Mô tả

We should have an explicit EOL policy guide and, potentially, an explicit support matrix. We can then move version numbers out of other docs.

Currently available:

Graphistry EOL policy is:

  • API deprecation:
    -- Avoid most deprecations by making new APIs additive vs. breaking
    -- Aim for 1+ year notification window when unavoidable
    -- Ex: We still support our 1.0 REST protocol, and are only now moving to officially deprecate it
  • Fixes go into new versions (vs. LTS patching)
  • Document breaking changes in the release changelog, as well as significant internal infra upgrades
  • Connectors: Latest major version of a product; we will be revisiting in Q2/Q3 for supporting multi-major-versions (e.g., we support both Neo4j 3 + Neo4j 4)
  • Manual support: 2yr old version for enterprise, 1yr old for cloud
Ngôn ngữ chính
Shell
Star
31
Fork
6
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

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

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

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 graphistry/graphistry-cli

Tất cả issue của graphistry/graphistry-cli

Issue tương tự

Thêm issue về Shell/Bash

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.