JuliaDocs/Documenter.jl

Reorganize `Hosting Documentation`

Open

#2 131 ouverte le 25 mai 2023

Voir sur GitHub
 (7 commentaires) (3 réactions) (0 assignés)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.

Guide contributeur

Stack technique
Aucun
Domaine
documentation
Type d'issue
documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
half day
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
fresh
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
mostly clear
Prérequis
basic knowledge of GitHub Actionsfamiliarity with Julia documentation
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75
Direction de recherche
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.