Updating the documentation for NUnit 4, a start..... #799
Conversation
|
@SeanKilleen Step 2 fails: Too many link fails it seems... help please! |
|
@OsirisTerje I wasn't expecting this in the queue today, sorry. I'm tied up with work stuff through this evening and likely won't be able to look at it until tomorrow morning Eastern at the earliest. |
|
@OsirisTerje the real issues are showing up in the first ~35 lines of build output on that step. They show the missing links and missing TOC files. The rest of the build output happens because we have a bunch of legacy docs files without templates, and I haven't figured out how to suppress it yet. FWIW, going forward you may want to open the docs in a GitHub codespace or in a dev container in VS code. That way you can make smaller changes and run "build" within that environment in order to pinpoint these more easily. |
|
@SeanKilleen I fixed the errors, and step 2 says it is a success, but with one warning, and is still marked red ?? |
|
@OsirisTerje I'll look into it. I also want to ensure we address more holistic issues before merging too. One example: if pages are moving, we need to ensure we are providing appropriate redirects within docfx so users aren't seeing broken links. Marking this as "request changes" just to make sure it doesn't accidentally get merged. I think I'll be able to look at it in an hour or so. |
|
@OsirisTerje I'm finally starting to look at this. Thank you for your patience! |
This has the happy coincidence of removing a great deal of the build output that was annoying @OsirisTerje and me :)
Based on warnings I was seeing in the container startup and then following directions at NodeSource
docs/articles/nunit/writing-tests/assertions/assertion-models/special.md
Show resolved
Hide resolved
|
Added some thoughts for review. Adding redirects for the moved files next, at which point this will be ready to merge if we choose to do so. |
|
@OsirisTerje I thought we had to do a lot more redirects but I saw that the titles of the URLs were changed for classic asserts, vs the URL location themselves. 👍 So I think after the remaining comments are worked through, this will be good to go |
docs/articles/nunit/writing-tests/assertions/assertion-models/classic.md
Outdated
Show resolved
Hide resolved
docs/articles/nunit/writing-tests/assertions/special-assertions/Assert.Fail.md
Outdated
Show resolved
Hide resolved
docs/articles/nunit/writing-tests/assertions/special-assertions/Assert.Ignore.md
Outdated
Show resolved
Hide resolved
docs/articles/nunit/writing-tests/assertions/special-assertions/Assert.Inconclusive.md
Outdated
Show resolved
Hide resolved
docs/articles/nunit/writing-tests/assertions/special-assertions/Assert.Pass.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Sean Killeen <SeanKilleen@gmail.com>
Co-authored-by: Sean Killeen <SeanKilleen@gmail.com>
* Updating the documentation for NUnit 4, a start..... * fixes * update * update * update * Update docfx action (and thus docfx) to latest This has the happy coincidence of removing a great deal of the build output that was annoying @OsirisTerje and me :) * Update the Node installer Based on warnings I was seeing in the container startup and then following directions at NodeSource * fix cross-reference * fix indending on nunit 4 doc * Add redirects for moved files * Remove warnings from Example code * Update docs/articles/nunit/writing-tests/Assumptions.md Co-authored-by: Sean Killeen <SeanKilleen@gmail.com> * Update docs/articles/nunit/Towards-NUnit4.md Co-authored-by: Sean Killeen <SeanKilleen@gmail.com> * update * update * update --------- Co-authored-by: Sean Killeen <SeanKilleen@gmail.com> Co-authored-by: Manfred Brands <manfred-brands@users.noreply.github.com> abcd03f
I have started on the doc changes needed for NUnit 4.
It is quite a mouthful, and I have trouble swallowing.
Also, @SeanKilleen , I might need quite a bit of help getting the links, the folders, and more into a manageable state. I have made a ton of changes, and I feel I lost control in a few places.
We should also get rid of all the docs referring to Changes as being from NUnit 2 to NUnit 3. Either delete them or move them into a separate deprecated or outdated section.