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 摘要。