Remove some metadata / yaml from docs
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 35/100
- Tipo di issue
- Refactoring
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- php
- Ambito
- documentation
Direzione di ricerca
Confronta i metadati in docs/*.md con le definizioni delle categorie in app/helpers/Content/Category/DevelopCategory.php e con le altre classi delle categorie. Determina se category, previous/next e subGuides possono essere rappresentati in modo coerente nelle classi delle categorie; il lavoro è completato quando il front matter duplicato viene rimosso senza perdere la struttura o la navigazione documentate.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
I was wondering if we actually need the metadata defined in the beginning of docs/*.md files?
category: Develop
previous: tests-ui
next: tests-travis
subGuides:
- plugin-settings
- piwiks-ini-configuration
In theory this information is already present in the category classes, isn't it? For example here: https://github.com/piwik/developer-documentation/blob/master/app/helpers/Content/Category/DevelopCategory.php
Depending on the path or filename of the markdown file we know the category. Currently, when moving a page to another category I do have to update the PHP category classes and update the related markdown file.
Also previous and next could be maybe automatically generated for all pages and not needed to be defined in the markdown files since we have that information already in the category class? Meaning we can find out whether there is a previous or next sibling.
With subGuides I was confused why it is sometimes defined in the markdown file and sometimes in a category class. I think we could just remove it and for simplicity always define it in the category class so one can immediately see the whole structure there and change things in one place.
Of course we'd have to create all category classes to know all this information but that should be fast. Especially since we cache pages.
- Lingua principale
- PHP
- Stelle
- 58
- Fork
- 88
- Merge medio
- 2g 10h
- PR unite (30g)
- 2
Preparare l'ambiente
Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di matomo-org/developer-documentation
-
Documentation enhancement
Difficoltà 1/5 1-3 ore Idoneità per principianti 68/100
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 45/100
-
bug
Difficoltà 4/5 3-5 giorni Idoneità per principianti 35/100
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 55/100
matomo-org/developer-documentation#806 · 2 commenti ·
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 25/100
matomo-org/developer-documentation#787 · 1 commento ·
Tutte le issue di matomo-org/developer-documentation
Issue simili
-
priority:low type:docs
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
crazy-goat/rabbit-stream#958 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
nextcloud/richdocuments#6250 ·
I maintainer di solito rispondono entro 1 giorno
-
sync-en
Difficoltà 1/5 1-3 ore Idoneità per principianti 83/100
I maintainer di solito rispondono entro 1 giorno
-
sync-en
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 75/100
I maintainer di solito rispondono entro 1 giorno
-
bug
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 88/100
FOSSBilling/FOSSBilling#4605 ·
I maintainer di solito rispondono entro 1 giorno