dotnet/EntityFramework.Docs

Make commands consistent

Open

#437 ouverte le 9 août 2017

Voir sur GitHub
 (1 commentaire) (0 réactions) (1 assigné)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

Guide contributeur

Stack technique
csharpshell
Domaine
documentation
Type d'issue
documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
half day
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
blocked
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
mostly clear
Prérequis
Knowledge of Entity Framework CoreFamiliarity with PMC and dotnet CLI commands
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
40
Direction de recherche
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.