InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns

Discover patterns by different names

Đang mở
#356 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.

(Self-) Hosting
Ngôn ngữ chính
HTML
Star
853
Fork
206
Merge trung bình
1 ngày 23 giờ
Pull request đã merge (30 ngày)
2

Mô tả

Some of our patterns are known by different names ("Titles" to be precise).

For example the Dedicated Community Leader is also known by as "Dedicated Community Manager".

It would be nice if readers of our book could find the pattern, no matter which name they are searching for.

Ideas

(1) URL redirects

Both of the following URLs could lead to the same content (i.e. to the dedicated-community-leader.md file).

  • patterns.innersourcecommons.org/p/dedicated-community-leader
  • patterns.innersourcecommons.org/p/dedicated-community-manager

gitbook (the service used for hosting our online book) is saying that this is currently not possible (as of Sept/2021).

Some more info from gitbook:

If I am not terribly mistaken, this will be possible or easier in our next upcoming big release. No date yet, but it should be soon.

(2) Index page

We could create a new page (e.g. called "Aliases") and then list all the different "names" for a given page, all of the names linking to the same URL (i.e. markdown file).

e.g. in the case above the markdown content of the Aliases file would be this:

[Dedicated Community Leader](dedicated-community-leader.md)
[Dedicated Community Manager](dedicated-community-leader.md)

Status of this issue

I would suggest to try solution (1), even if that means waiting for the next release of gitbook, before trying to do anything custom here.

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

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

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.

Hướng nghiên cứu

Bắt đầu bằng cách xem xét các liên kết pattern và mức hỗ trợ hiện tại của GitBook cho việc chuyển hướng URL, đặc biệt là ví dụ dedicated-community-leader.md. Công việc hoàn tất khi người đọc có thể tìm thấy cùng pattern bằng tiêu đề thay thế của nó, thông qua chuyển hướng hoặc một trang aliases được tài liệu hóa.

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

Đánh giá

Công nghệ
markdown
Lĩnh vực
documentation
Loại issue
Tính năng
Độ 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
45/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.