JuliaDocs/Documenter.jl

Reorganize `Hosting Documentation`

Open

#2,131 opened on May 25, 2023

View on GitHub
 (7 comments) (3 reactions) (0 assignees)Julia (910 stars) (513 forks)batch import
Type: Documentationhelp wanted

Description

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.

Contributor guide

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
basic knowledge of GitHub Actionsfamiliarity with Julia documentation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
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.