search

MicrosoftDocs / mixed-reality

Mixed Reality documentation
Creative Commons Attribution 4.0 International
173 stars 184 forks source link

Broken links to mrtk-unity docs throughout mixed-reality #224

Closed keveleigh closed 3 years ago

keveleigh commented 3 years ago

There are quite a few incorrect links to the MRTK docs that are linking to https://docs.microsoft.com/windows/mixed-reality/mrtk-docs/* instead of https://docs.microsoft.com/windows/mixed-reality/mrtk-unity/*. A good place to see this is the two links at the bottom of this page, in "See also":

image

though there are numerous examples of this typo throughout the docs. (The second link also still references "GitHub" in the text, even though it doesn't link to GitHub anymore)

Many of these links also still end in .md (for example, the aforementioned "Porting from HoloToolkit/MRTK to MRTK version 2 (GitHub)" link links to https://docs.microsoft.com/en-us/windows/mixed-reality/mrtk-docs/updates-deployment/hrtk-to-mrtk-porting-guide.md, which contains both issues.

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

polar-kev commented 3 years ago

FYI @varunsiddaraju. Are you able to take a look at these?

keveleigh commented 3 years ago

Via a rough search, possibly 67 incorrect links with both mrtk-docs and .md

image

and ~103 with mrtk-docs

image

varunsiddaraju commented 3 years ago

@polar-kev I'm looking into this issue and we will work on it.

@keveleigh Could you please let me know how to find those 67 incorrect links?

keveleigh commented 3 years ago

@varunsiddaraju I opened the repo in VS Code and used their regex search with string mrtk-docs\/.*\.md: image

After that, just searching for mrtk-docs should reveal any remaining issues (incorrect links that didn't have .md)

varunsiddaraju commented 3 years ago

Hi @polar-kev

For M/S doc migration, we were using mixed-reality-pr repo but this issue is created from mixed-reality repo so we are not sure whether we are supposed to work on this on this or not. Kindly, please clarify.

polar-kev commented 3 years ago

Hey @varunsiddaraju, please use the mixed-reality-pr repo for fixes.

The mixed-reality repo is a public repo that allows anyone looking at our docs to file an issue using the feedback button at the bottom of the page. image

The mixed-reality-pr repo is a private repo where we stage updates via our branches, review them, and push them live.

@hferrone, can you please confirm that the above is how we should be thinking of these repos?

hferrone commented 3 years ago

That is correct!

hferrone commented 3 years ago

@varunsiddaraju @polar-kev Is this fixed or does this need to remain open?

varunsiddaraju commented 3 years ago

@hferrone Thanks for checking up on this, We are still working on it, please keep it open.

veeruby-developer commented 3 years ago

@hferrone This Issue can be closed Now.