link validity checker

Ouverte
#50 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
3/5
Temps estimé
1-2 jours
Accessibilité débutants
35/100
Type d'issue
Fonctionnalité
Clarté
Plutôt claire
Activité
Active
Stack technique
github-actions, jupyter-notebook
Domaine
ci-cd, documentation

Piste de recherche

The payload names no specific files, so start by listing the repository's link-bearing files (its Jupyter notebooks and any Markdown) and check whether a .github/workflows directory already exists. Survey existing link-checker tools and choose one the maintainers can accept, since the issue leaves that decision open. Done means a GitHub Action that fails when a link in the repo is broken, and the choice of tool is explained in the pull request.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

documentation enhancement

There should be automated ways to check that all the links are valid throughout the repo. It looks like we haven't figured it out in CTSM either, but if we find an automated way to do it and can run a github action for it, that would be ideal.

Langage dominant
Jupyter Notebook
Étoiles
1
Forks
7
Merge moyen
8 h 32 min
PR mergées (30 j)
60

Préparer son environnement

Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de NCAR/CLM-Tutorial

Toutes les issues de NCAR/CLM-Tutorial

Issues similaires

Plus d'issues DevOps

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.