Docs: Remove redundant path segments from internal URLs

Created on 23 Feb 2019  路  18Comments  路  Source: dotnet/docs

There are a number of [](../) relative links starting with redundant path segments. They were generated when articles were migrated from MSDN, and could be removed now to make links short and clear.

For example,

https://github.com/dotnet/docs/blob/b0eb506433d5c29cab3e07186aee3cd80e76ab80/docs/framework/wpf/advanced/properties-wpf.md#L17

can be changed to

 - [Dependency Properties Overview](dependency-properties-overview.md)

Related to #9968

/cc @mairaw

bulk-changes doc-enhancement up-for-grabs

Most helpful comment

My suggestion since our team is still overwhelmed with PRs and behind on 3.0 work.
Let鈥檚 table this one for now and avoid tsunamis. 馃槉
Maybe do one of these per month to continue to make progress but not make them all at once.

All 18 comments

Thanks for filing this @NextTurn! There are a few examples on the repo where we've done this already.

e.g. https://github.com/dotnet/docs/pull/9992

For the [framework] section, here is the remaining work:

Links | Files | Directory
------|-------|----------
2795 | 735 | ./docs/framework/unmanaged-api/debugging
533 | 182 | ./docs/framework/unmanaged-api/diagnostics
2578 | 461 | ./docs/framework/unmanaged-api/hosting
1233 | 284 | ./docs/framework/unmanaged-api/metadata
1810 | 288 | ./docs/framework/unmanaged-api/profiling
1686 | 417 | ./docs/framework/wcf/diagnostics/tracing
2283 | 373 | ./docs/framework/wcf/feature-details
921 | 204 | ./docs/framework/wcf/samples

I could handle those changes in the coming days, but it might generate around 30 more PRs of 100~ files to review.

@mairaw, would you like me to continue pushing them or hold on a bit?

@mairaw If we adopt an automated approach to complete the work, do you just need to review the scripts instead of the changes?

Hi there,

@mairaw could you tell me/us what to do with the remaining work?

I'd like to continue to clean up the links path but was wondering how you prefer to get them packed in PRs.

hi guys
still got PR #14064 open and no answer on what we do with the remaining work... are you still interested with this cleanup?

Take it easy. These changes take time to review.

Yeah I totally understand, however the 15 other PRs were already merged
And it also takes time to resolve conflicts if the branch remains like this for months ;)

Take it easy. These changes take time to review.

And I just want to know if I continue working on this or take something else

I started reviewing that one but got busy with other deliverables. Will try to finish the review soon. Apologies for the delay.

You can choose whether you want to continue this one or work on something different.

I started reviewing that one but got busy with other deliverables. Will try to finish the review soon. Apologies for the delay.

I can totally understand with the core 3.0 launch ;)

You can choose whether you want to continue this one or work on something different.

I'll do what you prefer... I'm open to suggestions, but as you can see (https://github.com/dotnet/docs/issues/10653#issuecomment-525652922), there is kind of a hurricane coming if I batch work on this

My suggestion since our team is still overwhelmed with PRs and behind on 3.0 work.
Let鈥檚 table this one for now and avoid tsunamis. 馃槉
Maybe do one of these per month to continue to make progress but not make them all at once.

I've seen that others are also doing a great job on this, @NextTurn & @Youssef1313 for example.
I'll do as suggested and will do that as a background task.

Great to read you again @mairaw, have a great day all

Yes @nemrism, you're all doing great contributions to our docs and we really appreciate it!
Smaller PRs are much easier for our team to review as well. So if you'd like to continue to make progress towards this one, file a couple of PRs that are smaller in size and they will probably get reviewed and merged much faster.

Please feel free to use this new functionality from the Docs Authoring Pack when it is released tomorrow: https://github.com/microsoft/vscode-docs-authoring/pull/585

@IEvangelist How can I execute this command on all candidate files in a directory?

@IEvangelist How can I execute this command on all candidate files in a directory?

Hi @NextTurn - I'll see what I can do, but I originally didn't add that functionality. Although, that sounds like the desired way to do this.

Update

It was actually really straight forward, I've added a pull request and this will hopefully get merged in time for the next release. https://github.com/microsoft/vscode-docs-authoring/pull/587

Was this page helpful?
0 / 5 - 0 ratings

Related issues

sdmaclea picture sdmaclea  路  3Comments

svick picture svick  路  3Comments

gmatv picture gmatv  路  3Comments

Manoj-Prabhakaran picture Manoj-Prabhakaran  路  3Comments

garfbradaz picture garfbradaz  路  3Comments