Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Add more information to the Pages guide

オープン
#82 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
45/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
php
領域
documentation

調査の方向性

Pages guide から始め、既存の内容を developer.piwik/guides/controllers の controllers guide と比較してください。UI-test のリンク、権限チェック、ページの配置と空のテンプレート、Common::getRequestVar を扱い、Request::processRequest を別の API Requests guide に含めるべきか判断してください。要求された各トピックが、関連するリンクと例を伴って文書化されていれば完了です。

索引モデルが issue の本文から書いたものです。

説明

Documentation
  • How to test a page (with UI tests). We only have to mention it in a section and can link to the guide
  • We need to link to the Check permission guide and mention they have to take care of it if needed
  • Explain what they can do with pages (pretty much anything) (refs #80)
  • Explain how to place a page under the User section (extend user.twig in template)
  • Explain how to create a blank page (no extends *.twig) at the beginning of the template
  • Explain how to access $_GET and $_POST parameters via Common::getRequestVar
  • Not sure if it is needed how to call API methods via Request::processRequest. Probably rather not, this would be a separate guide maybe under Utils named "API Requests"? Shall we create an issue for this?

Parts of it can be maybe used from http://developer.piwik/guides/controllers

主要言語
PHP
スター
58
フォーク
88
平均マージ
2日 10時間
マージ済み PR(30日)
2

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

matomo-org/developer-documentation のほかの issue

matomo-org/developer-documentation の issue をすべて見る

似ている issue

PHP の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。