Remove some metadata / yaml from docs
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 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日 10時間
- マージ済み PR（30日）
- 2
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- 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 1週間以上 初心者へのやさしさ 25/100
matomo-org/developer-documentation#787 · コメント 1 件 ·
matomo-org/developer-documentation の issue をすべて見る
似ている issue
-
sync-en
難易度 1/5 1時間未満 初心者へのやさしさ 75/100
メンテナーはふだん 2 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
-
Documentation Feature: Events / Calendar
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
litespeedtech/lscache_wp#1079 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 71/100
Automattic/blocks-engine#3438 ·
メンテナーはふだん 1 日以内に返信