InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns
Discover patterns by different names
まだ誰も着手していません。
- 主要言語
- HTML
- スター
- 853
- フォーク
- 206
- 平均マージ
- 1日 23時間
- マージ済み PR(30日)
- 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-leaderpatterns.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.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、パターンへのリンクと、URL リダイレクトに関する GitBook の現在のサポート、特に dedicated-community-leader.md の例を確認します。読者が別のタイトルを使って同じパターンを見つけられるようになれば、作業は完了です。リダイレクトまたは文書化されたエイリアスページのいずれかを通じて実現します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- markdown
- 領域
- documentation
- issue の種類
- 機能追加
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 45/100