InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns

Discover patterns by different names

未關閉
#356 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

(Self-) Hosting
主要語言
HTML
星號
853
分支
206
平均合併
1 天 23 小時
30 天內合併 PR
2

描述

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.

貢獻指南

開啟貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

研究方向

首先檢查 pattern 連結以及 GitBook 目前對 URL 重新導向的支援情況,尤其是 dedicated-community-leader.md 範例。當讀者可以透過其替代標題找到相同的 pattern 時,工作即完成;這可以透過重新導向或一個有文件說明的別名頁面實現。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
markdown
領域
documentation
Issue 類型
功能
難度
3/5
預估耗時
1-2 天
活躍度
停滯
描述清晰度
基本清楚
新手友好度
45/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。