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

Troubleshooting docs

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

メンテナーはふだん 1 日以内に返信

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

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
25/100
issue の種類
ドキュメント
明瞭さ
説明が足りない
活発さ
停滞
領域
documentation

調査の方向性

まず既存のトラブルシューティングのトピックと、機能領域ごとの優先順位を確認し、次に不足しているシナリオについて L2 と L3 を参照します。ユーザーの症状、エラーメッセージ、具体的な解決策を中心に、一般的な制限事項ではなくトラブルシューティングのガイダンスが更新され、関連する不足箇所が特定されていれば完了です。

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

説明

epic

This epic is to track updates and doc bugs across the troubleshooting docs.

Notes from discussion with Alasdair:

Troubleshooting docs should take the approach of: "I'm doing x and getting this error. The solution is y." rather than just listing "limitations" or things that someone is just expected to remember. Troubleshooting docs, to be useful, need to be in a framing than enables the user to search/browse for something that describes the unfortunate situation that they're currently in. Then take their hand and make it all better. :)

The difference between troubleshooting and operations docs:

  • Troubleshooting Liberty is the kind of thing in this topic where you get a message and here's what to do about it.
  • Whereas, not analytics, logging, etc that we'd put in Operations.

Talk to L2 and L3:

  • Some of the tech docs online are troubleshooting "if you see x, then you need to do y".
  • talk to L2 and L3 to work out if there's things that we haven't covered that should be here

When prioritising troubleshooting work, follow the priority order of the functional areas of topics we've already got, in general.

主要言語
言語のデータがありません
スター
14
フォーク
58
平均マージ
1時間 4分
マージ済み PR(30日)
21

環境構築

はじめの一歩

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

OpenLiberty/docs のほかの issue

OpenLiberty/docs の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

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

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