Skip to content

removing articles from URL - #2079

Merged
mairaw merged 7 commits into
masterfrom
change-url
May 25, 2017
Merged

mairaw merged 7 commits into
masterfrom
change-url

Conversation

@mairaw

@mairaw mairaw commented May 3, 2017

Copy link
Copy Markdown
Contributor

No description provided.

@mairaw

mairaw commented May 17, 2017

Copy link
Copy Markdown
Contributor Author

@rpetrusha @guardrex @BillWagner i think this can be reviewed now and it would be important to do it. I think you need to use the branch url to see the behavior: https://review.docs.microsoft.com/en-us/dotnet-new/framework/?branch=change-url

I can't tell if breadcrumb is broken with this PR or not since a lot of times it doesn't work on staging. I think we will need to merge to master and test on the final master environment to make sure.

/cc @mikeblome

@mairaw mairaw added P0 and removed WIP labels May 17, 2017
@guardrex
guardrex requested review from tompratt-AQ and removed request for tompratt-AQ May 17, 2017 17:35
@guardrex

guardrex commented May 17, 2017 •

Copy link
Copy Markdown
Contributor

Sorry @tompratt-AQ ... stray mouse click! 🖱 🔫

@guardrex
guardrex self-requested a review May 17, 2017 17:43
@mairaw

mairaw commented May 17, 2017

Copy link
Copy Markdown
Contributor Author

I'm following up with the engineering team to see if I was supposed to see the fixed TOC on the branch or not. The steps they gave me might suggest I'd only see it fixed on master.

@guardrex

Copy link
Copy Markdown
Contributor

btw --- I almost have the review done. Just a few more links to check.

@mairaw

mairaw commented May 17, 2017

Copy link
Copy Markdown
Contributor Author

Thanks. The issue I see is that the TOC is not correct:
image

I'm doing a manual build to see if it fixes that.

@guardrex

Copy link
Copy Markdown
Contributor

My only concern was that with the review pending something might 💥.

@guardrex guardrex left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

"GuardRex strikes again!" - [@]piotrpMSFT

A couple of side questions, and most of these are comments on trailing slashes on links + link text to match the topic title (where you want to do that).

Comment thread .openpublishing.redirection.json Outdated
{
"source_path": "docs/cli-preview3/tools/dotnet-nuget-delete.md",
"redirect_url": "/dotnet/articles/core/preview3/tools/dotnet-nuget-delete"
"redirect_url": "/dotnet/core/preview3/tools/dotnet-nuget-delete"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Question: Looks like a redirect from a non-existent doc to a non-existent doc. Should there be an issue to remove (or re-point) these?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Good catch. The redirect existed at one point and got deleted. although the next redirect also exists so it wasn't a big deal.

"redirect_url": "/dotnet/standard/garbage-collection/weak-references"
},
{
"source_path": "docs/standard/getting-started.md",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Was the next one skipped by mistake?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I think some weird things happened when merging changes from master or maybe something I've overlooked. I think there's no /articles left in this file.

"redirect_url": "/dotnet/core/preview3/tools/dotnet-nuget-locals"
},
{
"source_path": "docs/core/app-types.md",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The next three still include articles ... on purpose?

---
# .NET Core and Open-Source
This topic provides a brief overview of what .NET Core is and shows how you can find more information. To find the complete list of topics for .NET Core, visit the [.NET Core documentation site](https://docs.microsoft.com/en-us/dotnet/articles/core/index)
This topic provides a brief overview of what .NET Core is and shows how you can find more information. To find the complete list of topics for .NET Core, visit the [.NET Core Guide](../../core/index.md).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

More of a question about the .NET Core Guide than about this link, but I wonder if that other doc should have its title changed to the .NET Core guide because it's currently just titled .NET Core. No big deal, but they don't currently match.

Whatever the case with that, I think this link text has to be "guide" (lowercase). The sentence case topic titles are in effect (I guess ur going to run that [@]spboyer script later on them), and that word isn't in the title of that topic anyway.

[.NET Core homepage](https://www.microsoft.com/net/core)
[.NET Core documentation site](https://docs.microsoft.com/en-us/dotnet/articles/core/index)
[ASP.NET Core Documentation](https://docs.asp.net/) No newline at end of file
[.NET Core documentation site](../core/index.md)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Topic title is ...

.NET Core

Double dots pair?

../../core/index.md

I hope one day that everything can go relative root. Just seems simpler even if a bit wordy for the topics that are more deeply nested than this one.

Later in this PR, there's a ./core/index.md (same folder path). For new community contributors, the EasyGrok:tm: approach is probably to eliminate as many dots as possible. Both links would just be ...

~/docs/core/index.md

... you don't need a Cray XC50 to figure out where they go! lol

/// in the course of a program's execution unless explicitly marked as mutable.
///
/// To learn more, see: https://docs.microsoft.com/dotnet/articles/fsharp/language-reference/values/index#why-immutable
/// To learn more, see: https://docs.microsoft.com/dotnet/fsharp/language-reference/values/index#why-immutable

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I thought we were leaving index off when going to index.md ???

https://docs.microsoft.com/dotnet/fsharp/language-reference/values/#why-immutable

// You can modify the contents of an an array element by using the left arrow assignment operator.
//
// To learn more about this operator, see: https://docs.microsoft.com/dotnet/articles/fsharp/language-reference/values/index#mutable-variables
// To learn more about this operator, see: https://docs.microsoft.com/dotnet/fsharp/language-reference/values/index#mutable-variables

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

/// Recursion is the preferred way to process sequences or collections in F#.
///
/// To learn more, see: https://docs.microsoft.com/dotnet/articles/fsharp/language-reference/functions/index#recursive-functions
/// To learn more, see: https://docs.microsoft.com/dotnet/fsharp/language-reference/functions/index#recursive-functions

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

/// To learn more about Classes, see: https://docs.microsoft.com/dotnet/fsharp/language-reference/classes
///
/// To learn more about Members, see: https://docs.microsoft.com/dotnet/articles/fsharp/language-reference/members
/// To learn more about Members, see: https://docs.microsoft.com/dotnet/fsharp/language-reference/members

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This link is not working for me. Maybe it got deleted and a redirect not put in place. I'll focus on just removing articles on this PR.

</Base>
<Docs>
<summary>Describes the different SQL authentication methods that can be used by a client connecting to Azure SQL Database. For details, see [Connecting to SQL Database By Using Azure Active Directory Authentication](https://azure.microsoft.com/documentation/articles/sql-database-aad-authentication/).</summary>
<summary>Describes the different SQL authentication methods that can be used by a client connecting to Azure SQL Database. For details, see [Connecting to SQL Database By Using Azure Active Directory Authentication](/azure/sql-database/sql-database-aad-authentication).</summary>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The topic title is ...

Use Azure Active Directory Authentication for authentication with SQL Database or SQL Data Warehouse

@guardrex

Copy link
Copy Markdown
Contributor

@mairaw There was one more note for a line where I couldn't attach a comment ...

.openpublishing.redirection.json Line 730 articles appears in the redirect_url

@mairaw

mairaw commented May 18, 2017

Copy link
Copy Markdown
Contributor Author

Ok, good news. Force publish resolved the TOC issue. I just resolved a merge conflict and once that's done, we can review and merge if things look good. I'll take a look at @guardrex's comments now, although they don't seem related to the goal of this PR which is only focused on removing the /articles from the URLs. 😄

@mairaw mairaw changed the title [DO NOT MERGE] removing articles from URL removing articles from URL May 18, 2017
@guardrex

Copy link
Copy Markdown
Contributor

don't seem related to the goal of this PR

... hence the quote by [@]piotrpMSFT: "GuardRex strikes again!" 😀

@mairaw

mairaw commented May 18, 2017

Copy link
Copy Markdown
Contributor Author

I can totally see where that comes from @guardrex 😄 but I like your attention to detail!

@guardrex

Copy link
Copy Markdown
Contributor

This is the third time this has happened: Two wrong guesses by me and once when I had the bright idea to ask @rpetrusha if he wanted a full review (app types topics; he requested full review on that one).

There's potentially a label option for PR's of "only-review-changes" vs. "full-review-request", but it would only probably apply to a GooberRex:tm: reviewer. Therefore, I'll prob just ask in the future if I'm unsure.

@mairaw
mairaw merged commit 24ae3c7 into master May 25, 2017
@mletterle

Copy link
Copy Markdown
Contributor

Just an FYI, the Pull #2012 mentions having a redirect from dotnet/articles/* to dotnet/* this doesn't appear to be occurring.

@BillWagner

Copy link
Copy Markdown
Member

Thanks @mletterle We're working on it. You can see the ongoing conversation on Issue #2259

@mletterle

Copy link
Copy Markdown
Contributor

Thanks @BillWagner, I'm seeing the redirects starting to go live now, so awesome!

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.

5 participants