jetstack / jetstack/jetstack-secure-gcm

Add missing required sections to the UI and CLI documentation

Đang mở
#37 0 bình luận 0 reaction 0 người được giao Xem trên GitHub
documentation
Ngôn ngữ chính
Mustache
Star
1
Fork
1
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

The Google documentation [states](https://cloud.google.com/marketplace/docs/partners/kubernetes-solutions/create-app-package#user-guide) that the user guide should contain certain sections. In the following list, I have checked the items that we already have:

- [x] Overview
- [x] One-time setup
- [x] Installation
- [x] Basic Usage (I added a section where I explain how to create a certificate)
- [ ] Back up and restore
- [ ] Image updates
- [ ] Scaling
- [ ] Deletion

This issue aims at reminding us to add the 4 missing sections both for the UI and the CLI instructions.

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

Hướng nghiên cứu

Locate the existing UI and CLI user guides and compare them with the required sections listed in the issue. Add Back up and restore, Image updates, Scaling, and Deletion to both guides; done means all four sections are present in each set of instructions.

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

Đánh giá

Lĩnh vực
cli, documentation, frontend
Loại issue
Tài liệu
Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
40/100

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.