JuliaDocs/Documenter.jl

Reorganize `Hosting Documentation`

Open

#2,131 建立於 2023年5月25日

在 GitHub 查看
 (7 留言) (3 反應) (0 負責人)Julia (910 star) (513 fork)batch import
Type: Documentationhelp wanted

描述

From the slack discussion:

Shuhei Kadowaki 4 minutes ago By the way, the section Authentication: SSH Deploy Keys should be in the parent section of GitHub, not in the Travis CI section? It often confuses me that I need to jump to the Travis section when I try to read through the instructions for GitHub actions (and I guess most people use GH actions more than Travis these days?)

Morten Piibeleht 2 minutes ago Yeah, that's an artifact from the Travis days :older_adult: In principle, that page should be reorganized and rewritten.

The main goal of this issue to make it easier to read through the instructions for GitHub Actions. Currently it is a bit confusing since a part of the instructions currently redirects to the Travis section, that is used rarely these days.

貢獻者指南

技術棧
無
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
basic knowledge of GitHub Actionsfamiliarity with Julia documentation
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
75
研究方向
The issue is to reorganize the hosting documentation to make GitHub Actions instructions easier to find. Currently, the 'Authentication: SSH Deploy Keys' section is under Travis CI but belongs under the GitHub section. Review the hosting documentation files (likely in docs/src/hosting) and restructure to prioritize GitHub Actions content. Ensure all internal links and navigation are updated accordingly.