Publish Form Tabs missing supporting documentation

Đang mở
  • Có gì không ổn?
#946 2 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
48/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
php
Lĩnh vực
documentation

Hướng nghiên cứu

Start by reading the tab-file, add-on setup, and add-on update documentation pages named in the issue. Clarify what it means to indicate a tab in the update file, document the tabs() function and its use during installation and uninstallation, and consider adding a table of contents to the update-file page. Done when the documentation explains these steps clearly.

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

Mô tả

Description of the problem
On https://docs.expressionengine.com/latest/development/tab-files.html#anatomy-of-a-tab-file it includes a note:

Note: if your module includes a tab, do not forget to indicate this in the update file when installing the module. Further, be sure to include the tabs() function in the update file, and use it when updating custom layouts on installation and uninstallation.

This doesn't really provide any useful information until more context is added to other places in the documentation.

  1. It's not clear what "indicate this in the update file" means or how to do that. https://docs.expressionengine.com/latest/development/addon-setup-php-file.html doesn't seem to have any additional information about that.
  2. https://docs.expressionengine.com/latest/development/add-on-update-file.html doesn't have any information about the tabs() function.

Edit: adding a Table of Contents to https://docs.expressionengine.com/latest/development/add-on-update-file.html would be helpful too.

Ngôn ngữ chính
CSS
Star
22
Fork
79
Merge trung bình
2 ngày 1 giờ
Pull request đã merge (30 ngày)
6

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 ExpressionEngine/ExpressionEngine-User-Guide

Tất cả issue của ExpressionEngine/ExpressionEngine-User-Guide

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.