dotnet/EntityFramework.Docs

Make commands consistent

Open

#437 opened on Aug 9, 2017

View on 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

Contributor guide

Tech stack
csharpshell
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Knowledge of Entity Framework CoreFamiliarity with PMC and dotnet CLI commands
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
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.