dotnet/EntityFramework.Docs

Make commands consistent

Open

#437 aberto em 9 de ago. de 2017

Ver no GitHub
 (1 comment) (0 reactions) (1 assignee)PowerShell (1.625 stars) (1.961 forks)batch import
area-toolsconsider-for-next-releasegood first issue

Description

Several small inconsistencies

  • Currently there are many PMC commands for which we don't include the dotnet CLI equivalent in the documentation, although it applies
  • Sometimes we use PM>, sometimes not, sometimes we just say Run or Execute and include the command inline.
  • We should consider making it so that it is always possible to click on Copy button and then paste on the real command line
  • Perhaps use PowerShell blocks for PMC, something else for dotnet CLI and other commands.
  • We should use tabs to show the different ways to do the same thing

Guia do colaborador

Pilha de tecnologia
csharpshell
Domain
documentation
Tipo Issue
documentation
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
half day
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
blocked
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
mostly clear
Prerequisites
Knowledge of Entity Framework CoreFamiliarity with PMC and dotnet CLI commands
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
40
Direção de pesquisa
The issue is assigned to someone, so first check the assignee's status. The goal is to standardize command formatting across the docs. Look for files containing 'PM>' or command examples, especially in tutorial pages and reference docs. The issue mentions using tabs and copy buttons; review existing template or markdown for code blocks. The maintainer may have additional guidelines.