InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns

Discover patterns by different names

Ouverte
#356 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

(Self-) Hosting
Langage dominant
HTML
Étoiles
853
Forks
206
Merge moyen
1 j 23 h
PR mergées (30 j)
2

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-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.

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par examiner les liens vers les patterns et la prise en charge actuelle des redirections d’URL par GitBook, en particulier l’exemple dedicated-community-leader.md. Le travail est terminé lorsque les lecteurs peuvent trouver le même pattern en utilisant son titre alternatif, soit via des redirections, soit via une page d’alias documentée.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
markdown
Domaine
documentation
Type d'issue
Fonctionnalité
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.