saltstack/salt

[DOCS] OpenNebula Function Reference - Suggests wrong CLI syntax

Chiusa

#64.520 aperta il 21 giu 2023

Vedi su GitHubGuida contributor
 (2 commenti) (0 reazioni) (0 assegnatari)Python (5508 fork)batch import
documentationgood first issuehelp-wantedmodule doc standardsseverity-mediumtime-estimate-quick-fix

Metriche repository

Star
 (13.710 stelle)
Metriche merge PR
 (Merge medio 72g 6h) (221 PR mergiate in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Il problema identifica una sintassi CLI errata nella documentazione di riferimento della funzione OpenNebula. La correzione comporta la rimozione dell'esempio errato dalla documentazione di Salt. Il file pertinente è probabilmente `salt/cloud/clouds/opennebula.rst` o un file simile nella directory `doc/`. Non esiste alcuna pull request o assegnatario collegato, quindi questo è disponibile per un contributore alle prime armi. La posizione specifica è la sezione della funzione 'create' del modulo cloud OpenNebula.
Tech stack
pythonshell
Dominio
documentationcli
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Nessuno
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85