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.