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.

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

Updated installation instructions #793

Merged
merged 23 commits into from
Sep 22, 2023
Merged

Updated installation instructions #793

merged 23 commits into from
Sep 22, 2023

Conversation

OsirisTerje
Copy link
Member

@OsirisTerje OsirisTerje commented Sep 22, 2023

Updated the installation instructions to be up-to-date with how things are done in 2023.

@OsirisTerje
Copy link
Member Author

@SeanKilleen Not sure why the site build fails, can you have a look?

So that it can be cross-referenced by ID rather than path
Should resolve the other xref warning
@SeanKilleen
Copy link
Member

@OsirisTerje the build was failing because there were docfx warnings upon generation which would have resulted in dead links, so we fail the build on those.

The build output is a bit verbose because of all the legacy docs, but if you go into the GitHub actions output and search for warning, you'll see starting on line 1588:

/github/workspace/docs/articles/nunit/getting-started/dotnet-core-and-dotnet-standard.md: warning UidNotFound: 1 invalid cross reference(s) "installation".
/github/workspace/docs/articles/nunit/getting-started/dotnet-core-and-dotnet-standard.md: Details for invalid cross reference(s): "" in line 5
/github/workspace/docs/articles/nunit/getting-started/installation.md: warning UidNotFound: 1 invalid cross reference(s) "nunitlite".
/github/workspace/docs/articles/nunit/getting-started/installation.md: Details for invalid cross reference(s): "" in line 136

This means you're using an xref reference for a link, but there's no uid on any page that gives it that ID, so you're referring to a page that docfx doesn't know how to find.

The solution is to give those pages uid values in their front-matter. I added two commits to do that, and you should be back on track now. 👍

docs/articles/nunit/getting-started/installation.md Outdated Show resolved Hide resolved
docs/articles/nunit/getting-started/installation.md Outdated Show resolved Hide resolved
docs/articles/nunit/getting-started/installation.md Outdated Show resolved Hide resolved
docs/articles/nunit/getting-started/installation.md Outdated Show resolved Hide resolved
docs/articles/nunit/getting-started/installation.md Outdated Show resolved Hide resolved
docs/articles/nunit/getting-started/installation.md Outdated Show resolved Hide resolved
docs/articles/nunit/getting-started/installation.md Outdated Show resolved Hide resolved
docs/articles/nunit/getting-started/installation.md Outdated Show resolved Hide resolved
docs/articles/nunit/getting-started/installation.md Outdated Show resolved Hide resolved
docs/articles/nunit/getting-started/installation.md Outdated Show resolved Hide resolved
docs/articles/nunit/getting-started/installation.md Outdated Show resolved Hide resolved
docs/articles/nunit/getting-started/installation.md Outdated Show resolved Hide resolved
docs/articles/nunit/getting-started/installation.md Outdated Show resolved Hide resolved
docs/articles/nunit/getting-started/installation.md Outdated Show resolved Hide resolved
docs/articles/nunit/getting-started/installation.md Outdated Show resolved Hide resolved
docs/articles/nunit/getting-started/installation.md Outdated Show resolved Hide resolved
docs/articles/nunit/getting-started/installation.md Outdated Show resolved Hide resolved
OsirisTerje and others added 15 commits September 22, 2023 16:54
Co-authored-by: Sean Killeen <SeanKilleen@gmail.com>
Co-authored-by: Sean Killeen <SeanKilleen@gmail.com>
Co-authored-by: Sean Killeen <SeanKilleen@gmail.com>
Co-authored-by: Sean Killeen <SeanKilleen@gmail.com>
Co-authored-by: Sean Killeen <SeanKilleen@gmail.com>
Co-authored-by: Sean Killeen <SeanKilleen@gmail.com>
Co-authored-by: Sean Killeen <SeanKilleen@gmail.com>
Co-authored-by: Sean Killeen <SeanKilleen@gmail.com>
Co-authored-by: Sean Killeen <SeanKilleen@gmail.com>
Co-authored-by: Sean Killeen <SeanKilleen@gmail.com>
Co-authored-by: Sean Killeen <SeanKilleen@gmail.com>
Co-authored-by: Sean Killeen <SeanKilleen@gmail.com>
Co-authored-by: Sean Killeen <SeanKilleen@gmail.com>
Co-authored-by: Sean Killeen <SeanKilleen@gmail.com>
…ndard.md

Co-authored-by: Sean Killeen <SeanKilleen@gmail.com>
Copy link
Member

@SeanKilleen SeanKilleen left a comment

Choose a reason for hiding this comment

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

👍 LGTM! Thanks for the overhaul!

@SeanKilleen SeanKilleen merged commit 257a56c into master Sep 22, 2023
7 checks passed
github-actions bot pushed a commit that referenced this pull request Sep 22, 2023
* Updated installation instructions

* Updated installation instructions

* give a UID to the installation page

So that it can be cross-referenced by ID rather than path

* Add uid for nunit lite runner

Should resolve the other xref warning

* Update docs/articles/nunit/getting-started/installation.md

Co-authored-by: Sean Killeen <SeanKilleen@gmail.com>

* Update docs/articles/nunit/getting-started/installation.md

Co-authored-by: Sean Killeen <SeanKilleen@gmail.com>

* Update docs/articles/nunit/getting-started/installation.md

Co-authored-by: Sean Killeen <SeanKilleen@gmail.com>

* Update docs/articles/nunit/getting-started/installation.md

Co-authored-by: Sean Killeen <SeanKilleen@gmail.com>

* Update docs/articles/nunit/getting-started/installation.md

Co-authored-by: Sean Killeen <SeanKilleen@gmail.com>

* Update docs/articles/nunit/getting-started/installation.md

Co-authored-by: Sean Killeen <SeanKilleen@gmail.com>

* Update docs/articles/nunit/getting-started/installation.md

Co-authored-by: Sean Killeen <SeanKilleen@gmail.com>

* Update docs/articles/nunit/getting-started/installation.md

Co-authored-by: Sean Killeen <SeanKilleen@gmail.com>

* Update docs/articles/nunit/getting-started/installation.md

Co-authored-by: Sean Killeen <SeanKilleen@gmail.com>

* Update docs/articles/nunit/getting-started/installation.md

Co-authored-by: Sean Killeen <SeanKilleen@gmail.com>

* Update docs/articles/nunit/getting-started/installation.md

Co-authored-by: Sean Killeen <SeanKilleen@gmail.com>

* Update docs/articles/nunit/getting-started/installation.md

Co-authored-by: Sean Killeen <SeanKilleen@gmail.com>

* Update docs/articles/nunit/getting-started/installation.md

Co-authored-by: Sean Killeen <SeanKilleen@gmail.com>

* Update docs/articles/nunit/getting-started/installation.md

Co-authored-by: Sean Killeen <SeanKilleen@gmail.com>

* Update docs/articles/nunit/getting-started/dotnet-core-and-dotnet-standard.md

Co-authored-by: Sean Killeen <SeanKilleen@gmail.com>

* Update docs/articles/nunit/getting-started/dotnet-core-and-dotnet-standard.md

* convert to note

* convert to note

* change markdown to use xml

---------

Co-authored-by: Sean Killeen <SeanKilleen@gmail.com> 257a56c
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants