Provide a guide how to use the HTTP Tracking API
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 45/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 領域
- api, documentation
調査の方向性
Integrate ページと Tracking API Reference から始め、特に既存の「Debugging the Tracker」セクションを確認してください。サンプルリクエストの構築、認証、テスト、リファレンスへのリンクを扱う独立したガイドの概要を作成してください。ガイドが Integrate からリンクされ、HTTP Tracking API の基本的なワークフローを説明していれば完了です。
索引モデルが issue の本文から書いたものです。
説明
When going to the Integrate page we see a couple of Tracking guides. The first two links "JS Tracking Client" and "Tracking API Clients" list clients that access the HTTP Tracking API. The third link is a guide how to use Content-Tracking via the HTTP Tracking API but there is actually no guide how to use the HTTP Tracking API which would be helpful if people want to write a client or if they want to track data in their application without using any of those clients.
I don't think we need a huge guide here but we need to explain some basics and the link to the Tracking API Reference.
At the end of the API Reference there is for example one part "Debugging the Tracker" which could be part of the guide. How to construct an example request could be moved there as well and explained in steps. We also need to explain when authentication is needed and how they can test it etc.
- 主要言語
- 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
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
Automattic/blocks-engine#3618 ·
メンテナーはふだん 1 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
MagnaCapax/PMSS#1206 ·
メンテナーはふだん 3 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
aimeos/aimeos-typo3#279 ·
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信