Discover patterns by different names
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 45/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- markdown
- Domain
- documentation
Research direction
Start by reviewing the pattern links and GitBook's current support for URL redirects, especially the dedicated-community-leader.md example. The work is done when readers can find the same pattern using its alternate title, either through redirects or a documented aliases page.
Written by the indexing model from the issue text.
Description
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.
- Dominant language
- HTML
- Stars
- 853
- Forks
- 206
- Avg merge
- 1d 23h
- Merged PRs (30d)
- 2
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from InnerSourceCommons/InnerSourcePatterns
-
community metrics
InnerSourceCommons/InnerSourcePatterns#935 · 1 assignee ·
-
community metrics
InnerSourceCommons/InnerSourcePatterns#934 · 1 assignee ·
-
community metrics
InnerSourceCommons/InnerSourcePatterns#922 · 1 assignee ·
-
community metrics
InnerSourceCommons/InnerSourcePatterns#921 · 1 assignee ·
-
community metrics
InnerSourceCommons/InnerSourcePatterns#915 · 1 assignee ·
All issues in InnerSourceCommons/InnerSourcePatterns
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 95/100
Git-it-App/git-it-electron#1047 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
neondatabase/website#5944 ·
-
📕documentation
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
db-ux-design-system/core-web#8239 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
libsdl-org/sdlwiki#1008 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100