freeCodeCamp / freeCodeCamp/devdocs

Allow hiding unwanted sub-sections

Đang mở
#1,703 0 bình luận 0 reaction 0 người được giao Xem trên GitHub
feature
Ngôn ngữ chính
Ruby
Star
39.5k
Fork
2.6k
Merge trung bình
4 ngày 32 phút
Pull request đã merge (30 ngày)
13

Mô tả

# Feature request

Provide an option to filter/hide sub-sections/topics of documentation. This can be a toggle and/or shortcut that hides a topic (and conversely un-hide from preferences or from the Documentation's root page).

## Summary

Currently, some documentation are in-depth and contain a number of topics (for example, Terraform contains 204 topics). These topics would fill up the sidebar making it inconvenient to scroll/select through plus the content within them would also be included with searches.

Specifying a subset that we want to focus our attention on would not only increase performance but also make this tool more usable than the original sources this information is coming from.

## Examples

Using Terraform as an example, the included documentation contains 204 topics available for searching.

![Terraform providers](https://user-images.githubusercontent.com/6453466/153261209-a164fda9-aa7e-40f7-a131-857efc65c0b2.png)

Usually, I would only work with a subset of platforms/providers. If I want to search for a specific subnet resource type, I can search for "subnet" through my interfaces but this returns a long list from all providers.

![Subnet Search Results](https://user-images.githubusercontent.com/6453466/153262554-f3cd143c-86ae-46c7-9295-7df12418cc52.png)

If I know I'm only working in OpenStack, then I will need to search for it within these results (notice it at the bottom of the list). If I was able to pre-define which topics to filter all searches and listings, I would be able to quickly identify the resource I need.

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

Mở hướng dẫn đóng góp

Hướng nghiên cứu

Rà soát trang gốc của tài liệu, thanh bên chủ đề, tùy chọn và kết quả tìm kiếm được mô tả trong issue. Trước tiên, xác định cách ẩn và khôi phục một tập hợp con các chủ đề được chọn; được xem là hoàn thành khi các chủ đề đã ẩn không còn xuất hiện trong danh sách hoặc kết quả tìm kiếm, trong khi người dùng có thể bỏ ẩn chúng từ các điểm truy cập được ghi lại trong tài liệu.

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

Đánh giá

Công nghệ
terraform
Lĩnh vực
documentation, search
Loại issue
Tính năng
Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
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
30/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.