Remove some metadata / yaml from docs
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 35/100
- Issue 类型
- 重构
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- php
调研方向
将 docs/*.md 中的元数据与 app/helpers/Content/Category/DevelopCategory.php 中的类别定义以及其他类别类进行比较。确定 category、previous/next 和 subGuides 是否可以在类别类中以一致的方式表示；完成的标准是移除重复的 front matter，同时不丢失文档化的结构或导航。
由索引模型根据 Issue 内容生成。
描述
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.
- 主要语言
- PHP
- 星标
- 58
- 派生
- 88
- 平均合并
- 2 天 13 小时
- 30 天内合并 PR
- 2
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
matomo-org/developer-documentation 的其他 Issue
-
Documentation enhancement
难度 1/5 1-3 小时 新手友好度 68/100
-
难度 4/5 3-5 天 新手友好度 45/100
-
bug
难度 4/5 3-5 天 新手友好度 35/100
-
难度 1/5 1 小时以内 新手友好度 55/100
matomo-org/developer-documentation#806 · 2 条评论 ·
-
难度 5/5 一周以上 新手友好度 25/100
matomo-org/developer-documentation#787 · 1 条评论 ·
查看 matomo-org/developer-documentation 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 75/100
维护者通常 1 天内回复
-
Include flows spanning the full report time window可能已有人在做 @somethingwithproof 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 77/100
Cacti/plugin_flowview#306 ·
维护者通常 1 天内回复
-
priority:low type:bug
难度 2/5 1-3 小时 新手友好度 82/100
crazy-goat/workerman-bundle#1189 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
Automattic/blocks-engine#5003 ·
维护者通常 1 天内回复
-
from-cloud mythic tracked
难度 1/5 1 小时以内 新手友好度 86/100
MythicalLTD/FeatherPanel#459 · 1 条评论 ·
维护者通常 1 天内回复