saltstack/salt

[DOCS] OpenNebula Function Reference - Suggests wrong CLI syntax

Fermée

#64 520 ouverte le 21 juin 2023

Voir sur GitHubGuide contributeur
 (2 commentaires) (0 réaction) (0 personne assignée)Python (5 508 forks)batch import
documentationgood first issuehelp-wantedmodule doc standardsseverity-mediumtime-estimate-quick-fix

Métriques du dépôt

Stars
 (13 710 étoiles)
Métriques de merge PR
 (Merge moyen 72j 6h) (221 PRs mergées en 30 j)

Description

Description If you look at the function reference for salt.cloud.clouds.opennebula at the Create function it suggests syntax of:

salt-cloud -p my-opennebula-profile vm_name memory=16384 cpu=2.5 vcpu=16

This appears to be incorrect, if you were to run such syntax you would end up creating 4 virtual machines called:

  1. vm_name
  2. memory=16384
  3. cpu=2.5
  4. vcpu=16

inside of OpenNebula, not a single VM with 16GB memory, 2.5 physical CPU cores and 16 virtual ones as you might expect.

Suggested Fix Remove this syntax from the documentation.

Type of documentation Salt module

Location or format of documentation https://docs.saltproject.io/en/latest/ref/clouds/all/salt.cloud.clouds.opennebula.html#salt.cloud.clouds.opennebula.create

Additional context None

Guide contributeur

Direction de recherche
Le problème identifie une syntaxe CLI incorrecte dans la documentation de référence de la fonction OpenNebula. La correction implique de supprimer l'exemple erroné de la documentation Salt. Le fichier concerné est probablement `salt/cloud/clouds/opennebula.rst` ou un fichier similaire dans le répertoire `doc/`. Aucune pull request ou responsable n'est lié, donc cela est disponible pour un contributeur débutant. L'emplacement spécifique est la section de la fonction 'create' du module cloud OpenNebula.
Stack technique
pythonshell
Domaine
documentationcli
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.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Aucun
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85