saltstack/salt

[DOCS] OpenNebula Function Reference - Suggests wrong CLI syntax

Fechada

#64.520 aberto em 21 de jun. de 2023

Ver no GitHubGuia do colaborador
 (2 comentários) (0 reação) (0 responsável)Python (5.508 forks)batch import
documentationgood first issuehelp-wantedmodule doc standardsseverity-mediumtime-estimate-quick-fix

Métricas do repositório

Stars
 (13.710 estrelas)
Métricas de merge de PR
 (Mesclagem média 72d 6h) (221 fundiu PRs em 30d)

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

Guia do colaborador

Direção de pesquisa
O problema identifica uma sintaxe CLI incorreta na documentação de referência da função OpenNebula. A correção envolve remover o exemplo errôneo da documentação do Salt. O arquivo relevante provavelmente é `salt/cloud/clouds/opennebula.rst` ou um arquivo similar no diretório `doc/`. Não há pull request ou responsável vinculado, portanto, isso está disponível para um contribuidor iniciante. A localização específica é a seção da função 'create' do módulo de nuvem OpenNebula.
Pilha de tecnologia
pythonshell
Domain
documentationcli
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
None
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85