Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Generate docs for dotnet nuget commands. #3253

Merged
merged 17 commits into from
Apr 8, 2020
Merged

Generate docs for dotnet nuget commands. #3253

merged 17 commits into from
Apr 8, 2020

Conversation

rrelyea
Copy link
Contributor

@rrelyea rrelyea commented Feb 21, 2020

Bug

Fixes: NuGet/Home#9146
Regression: no

Fix

Details: Helps generate documentation for dotnet commands.

Testing/Validation

Tests Added: No
Reason for not adding tests: Docs
Validation: Will iterate with docs team and feedback from team.

@rrelyea
Copy link
Contributor Author

rrelyea commented Feb 21, 2020

@karann-msft - can you give any feedback on the .md file in this change that will go to the dotnet cli docs?

@rrelyea rrelyea requested a review from nkolev92 February 21, 2020 23:22
@rrelyea
Copy link
Contributor Author

rrelyea commented Feb 28, 2020

Offline feedback from Tom Dykstra (sdk doc lead)
Yes, 6 files in our repo and then we can tweak the formatting in the PR that adds them. The format looks good, just a couple of issues I notice now --

  • ms.date format requires leading zero
  • our markdown linter requires a blank line before and after headings and code blocks, except the h1 goes right after the yaml block.
  • Acrolinx always advises to use present tense where possible -- "The ... command will update an existing source ..." --> "The ... command updates an existing source..."

@rrelyea rrelyea mentioned this pull request Feb 28, 2020
Closed
@rrelyea rrelyea requested a review from loic-sharma February 28, 2020 23:10
@rrelyea
Copy link
Contributor Author

rrelyea commented Mar 2, 2020

@loic-sharma - can you please re-review.

@rrelyea rrelyea requested a review from loic-sharma March 6, 2020 19:55
nkolev92
nkolev92 reviewed Mar 7, 2020
View reviewed changes
Copy link
Member

@nkolev92 nkolev92 left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a few quick questions before approving.

How will the publishing, flow from here to the docs repo work?

src/NuGet.Core/NuGet.CommandLine.XPlat/Commands/Commands.xml Outdated Show resolved Hide resolved
build/ttGen.ps1 Outdated Show resolved Hide resolved
@rrelyea
Copy link
Contributor Author

rrelyea commented Mar 9, 2020

created initial PR in dotnet docs repo here: dotnet/docs#17401

@rrelyea
Copy link
Contributor Author

rrelyea commented Mar 9, 2020

How will the publishing, flow from here to the docs repo work?

added some instructions in the different scripts/docs files. current process:

  • edit commands.xml and strings.resx to create commands/examples/etc.
  • generate docs.md from docs.tt via scripts\util\ttgen.ps1
  • split into separate files in your clone of dotnet/docs via scripts\util\docsPRGen.ps1
  • do additional edits of TOC, etc.. in your fork, then create PR to dotnet/docs

zivkan
zivkan reviewed Mar 27, 2020
View reviewed changes
Copy link
Member

@zivkan zivkan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with using contoso rather than realistic looking fake URLs.

Also, I think all the links to other docs pages needs to be fixed.

scripts/utils/ttGen.ps1 Outdated Show resolved Hide resolved
src/NuGet.Core/NuGet.CommandLine.XPlat/Commands/Commands.xml Outdated Show resolved Hide resolved
src/NuGet.Core/NuGet.CommandLine.XPlat/external/docsHelpers.t4 Outdated Show resolved Hide resolved
src/NuGet.Core/NuGet.CommandLine.XPlat/Commands/Commands.xml Show resolved Hide resolved
@rrelyea rrelyea mentioned this pull request Mar 31, 2020
Merged
@rrelyea rrelyea requested review from zivkan and nkolev92 March 31, 2020 19:51
nkolev92
nkolev92 approved these changes Mar 31, 2020
View reviewed changes
scripts/utils/ttGen.ps1 Show resolved Hide resolved
src/NuGet.Core/NuGet.CommandLine.XPlat/Commands/Verbs.tt Outdated Show resolved Hide resolved
@nkolev92
don't do 1 line if statement
9f63944 
Co-Authored-By: Nikolche Kolev <[email protected]>
@rrelyea rrelyea mentioned this pull request Apr 1, 2020
Open
@rrelyea
Copy link
Contributor Author

rrelyea commented Apr 8, 2020

https://devdiv.visualstudio.com/DevDiv/_build/results?buildId=3619936 failed e2e and apex.
but same commit succeeded on those same two passes in this build: https://devdiv.visualstudio.com/DevDiv/_build/results?buildId=3599215

@rrelyea rrelyea merged commit 9aa5274 into dev Apr 8, 2020
@rrelyea rrelyea deleted the dev-rrelyea-docsNuGetSources branch April 8, 2020 19:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nkolev92 nkolev92 nkolev92 approved these changes

@zivkan zivkan zivkan approved these changes

@aortiz-msft aortiz-msft Awaiting requested review from aortiz-msft

@cristinamanum cristinamanum Awaiting requested review from cristinamanum

@dominoFire dominoFire Awaiting requested review from dominoFire

@donnie-msft donnie-msft Awaiting requested review from donnie-msft

@dtivel dtivel Awaiting requested review from dtivel

@heng-liu heng-liu Awaiting requested review from heng-liu

@kartheekp-ms kartheekp-ms Awaiting requested review from kartheekp-ms

@zkat zkat Awaiting requested review from zkat

@loic-sharma loic-sharma Awaiting requested review from loic-sharma

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Automated creation of docs for dotnet nuget commands.
4 participants
@rrelyea @loic-sharma @nkolev92 @zivkan