InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns

Discover patterns by different names

Aperta
#356 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

(Self-) Hosting
Lingua principale
HTML
Stelle
853
Fork
206
Merge medio
1g 23h
PR unite (30g)
2

Descrizione

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.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia esaminando i link ai pattern e il supporto attuale di GitBook per i reindirizzamenti degli URL, in particolare l'esempio dedicated-community-leader.md. Il lavoro è completato quando i lettori possono trovare lo stesso pattern usando il suo titolo alternativo, tramite reindirizzamenti oppure una pagina degli alias documentata.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
markdown
Ambito
documentation
Tipo di issue
Funzionalità
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.