Mount autoops-insights cloud docs in site navigation
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 70/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 活発
- 技術スタック
- csharp, github, yaml
- 領域
- documentation, tooling
調査の方向性
まず config/navigation.yml と既存の AutoOps Elasticsearch エントリを読みます。ナビゲーションエントリで衝突しない path_prefix を設定し、ソース TOC をマウントする方法を確認します。autoops-insights://cloud に専用のプレフィックスで cloud TOC を追加します。既存の Elasticsearch エントリを維持したまま、ナビゲーションのプレフィックスチェッカーが cloud ページを受け入れることを確認します。
索引モデルが issue の本文から書いたものです。
説明
What is getting in your way?
elastic/autoops-insights is adding a second docs folder, generated/docs/cloud/, next to the existing generated/docs/elasticsearch/ catalog. docs-build on those PRs fails in NavigationPrefixChecker because the published navigation only mounts the Elasticsearch toc.
config/navigation.yml today:
# AutoOps insights
# https://github.com/elastic/autoops-insights/blob/main/generated/docs/elasticsearch/toc.yml
- toc: autoops-insights://elasticsearch
path_prefix: reference/autoops-insights
The cloud pages link to each other (cloud/index.md and the insight page). The assembler cannot place autoops-insights://cloud/... in the navigation, and those paths are not phantoms, so the build errors:
Can not validate 'autoops-insights://cloud/incident.md' it's not declared in any link reference nor is it a phantom
Can not validate 'autoops-insights://cloud/index.md' it's not declared in any link reference nor is it a phantom
The same check fails for autoops-insights://cloud/notice.md on the notice PR.
What would you like instead?
Add a navigation entry for autoops-insights://cloud (source toc: generated/docs/cloud/toc.yml in elastic/autoops-insights).
The existing Elasticsearch entry already owns reference/autoops-insights, so the cloud prefix has to be chosen so it does not collide with that prefix. Two open content PRs are blocked on this:
- https://github.com/elastic/autoops-insights/pull/189 (
SERVICE_INCIDENT, run https://github.com/elastic/autoops-insights/actions/runs/38902471178) - https://github.com/elastic/autoops-insights/pull/186 (
CUSTOMER_NOTICE, run https://github.com/elastic/autoops-insights/actions/runs/38899902779)
Anything else?
Vale and the docs prose checks pass. Only the navigation prefix check fails. The cloud toc currently lists index.md plus one insight page (incident.md or notice.md, depending on which PR merges first).
- 主要言語
- C#
- スター
- 25
- フォーク
- 44
- 平均マージ
- 17時間 21分
- マージ済み PR（30日）
- 343
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
elastic/docs-builder のほかの issue
-
bug needs triage
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
elastic/docs-builder#4697 ·
メンテナーはふだん 1 日以内に返信
-
needs triage
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
elastic/docs-builder#4232 ·
メンテナーはふだん 1 日以内に返信
-
chore needs triage tech-debt
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
elastic/docs-builder#3567 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
chore needs triage tech-debt
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
elastic/docs-builder#3566 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
enhancement needs triage tech-debt
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
elastic/docs-builder#4721 ·
メンテナーはふだん 1 日以内に返信
elastic/docs-builder の issue をすべて見る
似ている issue
-
Docs typoオープン
難易度 1/5 1時間未満 初心者へのやさしさ 78/100
MonoGame/docs.monogame.github.io#328 · コメント 1 件 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
space-wizards/RobustToolbox#7197 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 83/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
RicoSuter/Namotion.Interceptor#918 ·
メンテナーはふだん 1 日以内に返信