dotnet/EntityFramework.Docs

Make commands consistent

Open

Aperta il 9 ago 2017

Vedi su GitHub
 (1 commento) (0 reazioni) (1 assegnatario)PowerShell (1625 star) (1961 fork)batch import
area-toolsconsider-for-next-releasegood first issue

Descrizione

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

Guida contributor

Tech stack
csharpshell
Dominio
documentation
Tipo issue
documentation
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
half day
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
blocked
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
mostly clear
Prerequisiti
Knowledge of Entity Framework CoreFamiliarity with PMC and dotnet CLI commands
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
40
Direzione di ricerca
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.