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

Create custom domain for Read the Docs site

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

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

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

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
35/100
issue の種類
機能追加
明瞭さ
説明が足りない
活発さ
停滞
領域
documentation

調査の方向性

まず issue 84 と、issue にリンクされている Read the Docs のカスタムドメインガイドを確認します。RTD サイトで /api/client または /client パスを使用して docs.dandiarchive.org を利用できるかどうかを判断し、その後、必要なアカウント認証情報と設定を確認します。DANDI Client の RTD サイトが合意したカスタム URL で到達可能になれば完了です。

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

説明

Issue description

Given the recent updates to the website routes (see https://github.com/dandi/dandi.github.io/issues/84) and particularly the renaming of the DANDI Handbook to docs.dandiarchive.org, as @yarikoptic points out it is confusing that we have a dandi RTD site for the DANDI Client.

Possible solution

I propose that we create a custom domain for the RTD site and use docs.dandiarchive.org/api/client or docs.dandiarchive.org/client. RTD allows for custom domains but we will need to investigate further if we can use a custom domain that also includes a path (e.g. /api/client).

If we agree on this being the solution, I would be happy to work on this. I will just need the credentials for the dandi RTD account.

主要言語
Python
スター
29
フォーク
37
平均マージ
1日 5時間
マージ済み PR(30日)
20

環境構築

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

はじめの一歩

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

dandi/dandi-cli のほかの issue

dandi/dandi-cli の issue をすべて見る

似ている issue

Python の issue をもっと見る

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

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