saltstack/salt

[DOCS] OpenNebula Function Reference - Suggests wrong CLI syntax

Geschlossen

#64.520 geöffnet am 21.06.2023

Auf GitHub ansehenContributor Guide
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (5.508 Forks)batch import
documentationgood first issuehelp-wantedmodule doc standardsseverity-mediumtime-estimate-quick-fix

Repository-Metriken

Stars
 (13.710 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 72T 6h) (221 gemergte PRs in 30 T)

Beschreibung

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

Contributor Guide

Research-Richtung
Das Problem identifiziert eine falsche CLI Syntax in der OpenNebula Funktionsreferenzdokumentation. Die Korrektur beinhaltet das Entfernen des fehlerhaften Beispiels aus der Salt Dokumentation. Die relevante Datei ist wahrscheinlich `salt/cloud/clouds/opennebula.rst` oder eine ähnliche Datei im `doc/` Verzeichnis. Es gibt keinen verknüpften Pull Request oder Zuständigen, daher ist dies für einen Erstbeitragenden verfügbar. Der spezifische Ort ist der 'create' Funktionsabschnitt des OpenNebula Cloud Moduls.
Tech Stack
pythonshell
Domain
documentationcli
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Keine
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85