Remove some metadata / yaml from docs
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 35/100
- Tipo de issue
- Refactorización
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- php
- Área
- documentation
Línea de trabajo
Compara los metadatos de docs/*.md con las definiciones de categorías en app/helpers/Content/Category/DevelopCategory.php y las demás clases de categorías. Determina si category, previous/next y subGuides pueden representarse de forma coherente en las clases de categorías; se considera terminado cuando se elimina el front matter duplicado sin perder la estructura ni la navegación documentadas.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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.
- Lenguaje dominante
- PHP
- Estrellas
- 58
- Forks
- 88
- Merge medio
- 2 d 10 h
- PR fusionados (30 d)
- 2
Preparar el entorno
Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de matomo-org/developer-documentation
-
Documentation enhancement
Dificultad 1/5 1-3 horas Aptitud para principiantes 68/100
-
Dificultad 4/5 3-5 días Aptitud para principiantes 45/100
-
bug
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 55/100
matomo-org/developer-documentation#806 · 2 comentarios ·
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
matomo-org/developer-documentation#787 · 1 comentario ·
Todos los issues de matomo-org/developer-documentation
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
litespeedtech/lscache_wp#1079 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 71/100
Automattic/blocks-engine#3438 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 66/100
FriendsOfFlarum/upload#549 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
getgrav/grav-plugin-api#66 ·