MicrosoftDocs
Brianpmccullough community docs
Please use this template to ensure easier processing of your pull request
Category
- [ ] Content fix
- [ ] New article
- [x] Example checked item (delete this line)
Related issues
- fixes #1090
Contents of the Pull Request
New article, along with media assets (screenshots), to cover use of Link, News Link, and Link to a Document.
Guidance
Learn Build status updates of commit b19c97e:
:warning: Validation status: warnings
Community/making-good-technology-decisions--link-vs-link-to-a-document.md
- Line 2, Column 1: [Warning: ms-author-missing - See documentation]
Missing required attribute: 'ms.author'. Add the current author's Microsoft alias. - Line 9, Column 13: [Warning: ms-service-subservice-invalid - See documentation]
Invalid value for 'ms.service': 'SharePoint Online'. - Line 0, Column 0: [Suggestion: filename-incomplete - See documentation]
The filename contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed. - Line 2, Column 1: [Suggestion: manager-missing - See documentation]
Missing required attribute: 'manager'. Add a valid Microsoft alias for the author's manager.
Community/media/making-good-technology-decisions--link-vs-link-to-a-document/Link-Document-ContentType.jpg
- Line 0, Column 0: [Suggestion: image-name-invalid-character - See documentation]
Only lowercase letters, numbers, and hyphens are allowed in image names. - Line 0, Column 0: [Suggestion: image-name-incomplete - See documentation]
The image name contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.
Community/media/making-good-technology-decisions--link-vs-link-to-a-document/Link-Document-HighlightedContent.jpg
- Line 0, Column 0: [Suggestion: image-name-invalid-character - See documentation]
Only lowercase letters, numbers, and hyphens are allowed in image names. - Line 0, Column 0: [Suggestion: image-name-incomplete - See documentation]
The image name contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.
Community/media/making-good-technology-decisions--link-vs-link-to-a-document/Link-Documents-CreateInternalLink.png
- Line 0, Column 0: [Suggestion: image-name-invalid-character - See documentation]
Only lowercase letters, numbers, and hyphens are allowed in image names. - Line 0, Column 0: [Suggestion: image-name-incomplete - See documentation]
The image name contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.
Community/media/making-good-technology-decisions--link-vs-link-to-a-document/Link-Search.jpg
- Line 0, Column 0: [Suggestion: image-name-invalid-character - See documentation]
Only lowercase letters, numbers, and hyphens are allowed in image names.
Community/media/making-good-technology-decisions--link-vs-link-to-a-document/Link-SitePages-Metadata.png
- Line 0, Column 0: [Suggestion: image-name-invalid-character - See documentation]
Only lowercase letters, numbers, and hyphens are allowed in image names. - Line 0, Column 0: [Suggestion: image-name-incomplete - See documentation]
The image name contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.
Community/media/making-good-technology-decisions--link-vs-link-to-a-document/Link-SitePages-Web.png
- Line 0, Column 0: [Suggestion: image-name-invalid-character - See documentation]
Only lowercase letters, numbers, and hyphens are allowed in image names. - Line 0, Column 0: [Suggestion: image-name-incomplete - See documentation]
The image name contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.
Community/media/making-good-technology-decisions--link-vs-link-to-a-document/LinkToADocument-AddToLibrary.jpg
- Line 0, Column 0: [Suggestion: image-name-invalid-character - See documentation]
Only lowercase letters, numbers, and hyphens are allowed in image names. - Line 0, Column 0: [Suggestion: image-name-incomplete - See documentation]
The image name contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.
Community/media/making-good-technology-decisions--link-vs-link-to-a-document/LinkToADocument-ASPX.jpg
- Line 0, Column 0: [Suggestion: image-name-invalid-character - See documentation]
Only lowercase letters, numbers, and hyphens are allowed in image names. - Line 0, Column 0: [Suggestion: image-name-incomplete - See documentation]
The image name contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.
Community/media/making-good-technology-decisions--link-vs-link-to-a-document/LinkToADocument-HighlightedContentWebPart.jpg
- Line 0, Column 0: [Suggestion: image-name-invalid-character - See documentation]
Only lowercase letters, numbers, and hyphens are allowed in image names. - Line 0, Column 0: [Suggestion: image-name-incomplete - See documentation]
The image name contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.
Community/media/making-good-technology-decisions--link-vs-link-to-a-document/LinkToADocument-New.jpg
- Line 0, Column 0: [Suggestion: image-name-invalid-character - See documentation]
Only lowercase letters, numbers, and hyphens are allowed in image names. - Line 0, Column 0: [Suggestion: image-name-incomplete - See documentation]
The image name contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.
Community/media/making-good-technology-decisions--link-vs-link-to-a-document/LinkToADocument-NewForm.jpg
- Line 0, Column 0: [Suggestion: image-name-invalid-character - See documentation]
Only lowercase letters, numbers, and hyphens are allowed in image names. - Line 0, Column 0: [Suggestion: image-name-incomplete - See documentation]
The image name contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.
This comment lists only the first 25 errors (including error/warning/suggestion) in the pull request. For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
![learn-build-service-prod[bot] avatar](https://avatars.githubusercontent.com/in/237442?v=4 "Published by a pub.dev verified publisher"){kind=small}
@brianpmccullough - Thanks for the submission! Most of those warnings look to be something on our end. I'll try to get that sorted and review your submission ASAP.
Learn Build status updates of commit e31e21c:
:bulb: Validation status: suggestions
Community/making-good-technology-decisions--link-vs-link-to-a-document.md
- Line 0, Column 0: [Suggestion: filename-incomplete - See documentation]
The filename contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.
Community/media/making-good-technology-decisions--link-vs-link-to-a-document/Link-Search.jpg
- Line 0, Column 0: [Suggestion: image-name-invalid-character - See documentation]
Only lowercase letters, numbers, and hyphens are allowed in image names.
Community/media/making-good-technology-decisions--link-vs-link-to-a-document/Link-SitePages-Metadata.png
- Line 0, Column 0: [Suggestion: image-name-invalid-character - See documentation]
Only lowercase letters, numbers, and hyphens are allowed in image names. - Line 0, Column 0: [Suggestion: image-name-incomplete - See documentation]
The image name contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.
Community/media/making-good-technology-decisions--link-vs-link-to-a-document/Link-SitePages-Web.png
- Line 0, Column 0: [Suggestion: image-name-invalid-character - See documentation]
Only lowercase letters, numbers, and hyphens are allowed in image names. - Line 0, Column 0: [Suggestion: image-name-incomplete - See documentation]
The image name contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.
Community/media/making-good-technology-decisions--link-vs-link-to-a-document/link-to-a-document-aspx.jpg
- Line 0, Column 0: [Suggestion: image-name-incomplete - See documentation]
The image name contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
@sympmarc actually a few were related to image file names, so I went ahead and made those adjustments. For some of the attributes, I used the value: "pamgreen" as that's what many other articles were using. Once we clear up all the warnings, I'll handle the license stuff.
Learn Build status updates of commit e8b79fd:
:bulb: Validation status: suggestions
Community/making-good-technology-decisions--link-vs-link-to-a-document.md
- Line 0, Column 0: [Suggestion: filename-incomplete - See documentation]
The filename contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.
Community/media/making-good-technology-decisions--link-vs-link-to-a-document/Link-Search.jpg
- Line 0, Column 0: [Suggestion: image-name-invalid-character - See documentation]
Only lowercase letters, numbers, and hyphens are allowed in image names.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
Learn Build status updates of commit b8b6824:
:bulb: Validation status: suggestions
Community/making-good-technology-decisions--link-vs-link-to-a-document.md
- Line 0, Column 0: [Suggestion: filename-incomplete - See documentation]
The filename contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
Learn Build status updates of commit 64fa647:
:warning: Validation status: warnings
Community/making-good-technology-decisions--link-vs-link-to-a-document.md
- Line 30, Column 1: [Warning: file-not-found - See documentation]
Invalid file link: 'media/making-good-technology-decisions--link-vs-link-to-a-document/link-site-pages-web.png'. - Line 31, Column 1: [Warning: file-not-found - See documentation]
Invalid file link: 'media/making-good-technology-decisions--link-vs-link-to-a-document/link-documents-create-internal-link.png'. - Line 42, Column 1: [Warning: file-not-found - See documentation]
Invalid file link: 'media/making-good-technology-decisions--link-vs-link-to-a-document/link-document-content-type.jpg'. - Line 49, Column 1: [Warning: file-not-found - See documentation]
Invalid file link: 'media/making-good-technology-decisions--link-vs-link-to-a-document/link-document-highlighted-content.jpg'. - Line 55, Column 1: [Warning: file-not-found - See documentation]
Invalid file link: 'media/making-good-technology-decisions--link-vs-link-to-a-document/link-search.jpg'. - Line 67, Column 1: [Warning: file-not-found - See documentation]
Invalid file link: 'media/making-good-technology-decisions--link-vs-link-to-a-document/news-link-create.jpg'. - Line 74, Column 1: [Warning: file-not-found - See documentation]
Invalid file link: 'media/making-good-technology-decisions--link-vs-link-to-a-document/news-link-promoted-state-content-type.jpg'. - Line 75, Column 1: [Warning: file-not-found - See documentation]
Invalid file link: 'media/making-good-technology-decisions--link-vs-link-to-a-document/news-link-web-parts.jpg'. - Line 83, Column 1: [Warning: file-not-found - See documentation]
Invalid file link: 'media/making-good-technology-decisions--link-vs-link-to-a-document/link-to-a-document-add-to-library.jpg'. - Line 87, Column 1: [Warning: file-not-found - See documentation]
Invalid file link: 'media/making-good-technology-decisions--link-vs-link-to-a-document/link-to-a-document-new.jpg'. - Line 88, Column 1: [Warning: file-not-found - See documentation]
Invalid file link: 'media/making-good-technology-decisions--link-vs-link-to-a-document/link-to-a-document-new-form.jpg'. - Line 89, Column 1: [Warning: file-not-found - See documentation]
Invalid file link: 'media/making-good-technology-decisions--link-vs-link-to-a-document/link-to-a-document-new-form-custom-properties.jpg'. - Line 93, Column 1: [Warning: file-not-found - See documentation]
Invalid file link: 'media/making-good-technology-decisions--link-vs-link-to-a-document/link-to-a-document-file-type-in-document-library.jpg'. - Line 97, Column 1: [Warning: file-not-found - See documentation]
Invalid file link: 'media/making-good-technology-decisions--link-vs-link-to-a-document/link-to-a-document-highlighted-content-web-part.jpg'. - Line 101, Column 1: [Warning: file-not-found - See documentation]
Invalid file link: 'media/making-good-technology-decisions--link-vs-link-to-a-document/link-to-a-document-search-results.jpg'. - Line 0, Column 0: [Suggestion: filename-incomplete - See documentation]
The filename contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
Learn Build status updates of commit 9023ad1:
:bulb: Validation status: suggestions
Community/making-good-technology-decisions--link-vs-link-to-a-document.md
- Line 0, Column 0: [Suggestion: filename-incomplete - See documentation]
The filename contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
Learn Build status updates of commit 209c28b:
:bulb: Validation status: suggestions
Community/making-good-technology-decisions--comparing-link-news-link-and-link-to-a-document.md
- Line 0, Column 0: [Suggestion: filename-exceeds-max-length - See documentation]
The filename exceeds 80 characters in length. Filenames must be 80 characters or less. - Line 0, Column 0: [Suggestion: filename-contains-stop-word - See documentation]
Stop words like 'a', 'or', 'and', 'the', and 'in' are discouraged in filenames. - Line 0, Column 0: [Suggestion: filename-incomplete - See documentation]
The filename contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
Learn Build status updates of commit 60af8b5:
:bulb: Validation status: suggestions
Community/making-good-technology-decisions--compare-link-news-link-and-link-to-a-document.md
- Line 0, Column 0: [Suggestion: filename-contains-stop-word - See documentation]
Stop words like 'a', 'or', 'and', 'the', and 'in' are discouraged in filenames. - Line 0, Column 0: [Suggestion: filename-incomplete - See documentation]
The filename contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
@sympmarc sorry for the churn above. had a few renaming things that I didn't double check before I pushed. let me know if I can do anything to help this through.
Thanks for your perseverance, @brianpmccullough! There have been some recent changes to the rules for file naming, etc. I didn't know why you got those warnings, TBH, but I checked with @pamgreen-msft about it, and I appreciate your willingn ess to take care of the warnings.
I'll review the article for posting!
It's great! Could you do me a favor before we publish it and check the second and third images? They have red boxes which seem to be in odd places, which might confuse people.
Learn Build status updates of commit 676b3fc:
:bulb: Validation status: suggestions
Community/making-good-technology-decisions--compare-link-news-link-and-link-to-a-document.md
- Line 0, Column 0: [Suggestion: filename-contains-stop-word - See documentation]
Stop words like 'a', 'or', 'and', 'the', and 'in' are discouraged in filenames. - Line 0, Column 0: [Suggestion: filename-incomplete - See documentation]
The filename contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
Learn Build status updates of commit 11f113e:
:bulb: Validation status: suggestions
Community/making-good-technology-decisions--compare-link-news-link-and-link-to-a-document.md
- Line 0, Column 0: [Suggestion: filename-contains-stop-word - See documentation]
Stop words like 'a', 'or', 'and', 'the', and 'in' are discouraged in filenames. - Line 0, Column 0: [Suggestion: filename-incomplete - See documentation]
The filename contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
@sympmarc Not a problem at all. I've fixed the images. Don't know what happened there, other than using a new image editor app on my Mac, so must have messed up something. If there are other edits or suggestions, please let me know! First time contributing here, but have contributed elsewhere (pnp, etc).
Learn Build status updates of commit 760f1a9:
:bulb: Validation status: suggestions
Community/making-good-technology-decisions--compare-link-news-link-and-link-to-a-document.md
- Line 0, Column 0: [Suggestion: filename-contains-stop-word - See documentation]
Stop words like 'a', 'or', 'and', 'the', and 'in' are discouraged in filenames. - Line 0, Column 0: [Suggestion: filename-incomplete - See documentation]
The filename contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
Learn Build status updates of commit 8798953:
:bulb: Validation status: suggestions
Community/making-good-technology-decisions--compare-link-news-link-and-link-to-a-document.md
- Line 0, Column 0: [Suggestion: filename-contains-stop-word - See documentation]
Stop words like 'a', 'or', 'and', 'the', and 'in' are discouraged in filenames. - Line 0, Column 0: [Suggestion: filename-incomplete - See documentation]
The filename contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
Thanks so much, @brianpmccullough. I'm going to get this added to the navigation and published ASAP!
Great. Thanks @sympmarc ! I wonder if Microsoft knows about and expects the behavior of "Link" in Search Results and rollup web parts like Highlighted Content. It seems like it should function like the "Link to a Document" where it automatically redirects the user to the target content, rather than a display form that looks like an "error" or "warning". Maybe being MVP you have someone's ear that I wouldn't?
Learn Build status updates of commit 2b5ac05:
:bulb: Validation status: suggestions
Community/making-good-technology-decisions--compare-link-news-link-and-link-to-a-document.md
- Line 0, Column 0: [Suggestion: filename-contains-stop-word - See documentation]
Stop words like 'a', 'or', 'and', 'the', and 'in' are discouraged in filenames. - Line 0, Column 0: [Suggestion: filename-incomplete - See documentation]
The filename contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
Learn Build status updates of commit 1c8d6eb:
:bulb: Validation status: suggestions
Community/making-good-technology-decisions--compare-link-news-link-and-link-to-a-document.md
- Line 0, Column 0: [Suggestion: filename-contains-stop-word - See documentation]
Stop words like 'a', 'or', 'and', 'the', and 'in' are discouraged in filenames. - Line 0, Column 0: [Suggestion: filename-incomplete - See documentation]
The filename contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
Hi @brianpmccullough
Following is a blocking issues that need to be resolved before we can merge:
There are double hyphens in all the file names. Please retain only one hyphen in all the file names.
Reference
Criteria used for pull request reviews
Blocking Names for new files and folders follow these guidelines:
- Use only lowercase letters, hyphens, and numbers. No spaces, underscores, or other special characters. (All file types)
- Maximum length is 80 characters, which is a publishing system limit. (All file types)
- Use action verbs that are specific, such as develop, buy, build, or troubleshoot. Avoid "-ing" words. (Folders and articles)
- Don't use unnecessary small words, such as a, or, and, the, and in. (Folders) Exception: Names of files and folders for PowerShell reference content should match the capitalization of the modules and cmdlets that they document. It's the contributor's responsibility to ensure that these are correct.
After you resolve the blocking issues, remove the Back to submitter label and add the Sign off label again.
If you need help resolving issues in this PR, post your question in the Ask an Admin Teams Channel.
Thanks, Padma
@padmagit77 I was following pattern from other articles. So preference would be to break consistency with other articles with new rules, correct?
I'm sorry, @brianpmccullough. The rules Microsoft has for naming and such is changing a lot lately, and some of the old patterns we have used are now verboten. @padmagit77 is enforcing rules we didn't know about yet!
cc: @pamgreen-msft
@brianpmccullough
#non-blocking comment
Since there are only suggestions in this PR, I am going ahead and merging it. However, we may be required to enforce the double hyphen restriction if it ever becomes a warning and we recommend you come up with a new convention. Kindly add the signoff label so that I can merge it.
Thanks, @padmagit77. We can make bulk changes on this kind of thing when we know about it.
@sympmarc @padmagit77 happy to help a bulk update to enforce renaming conventions. Best place to reach me is LinkedIn via same handle I have here. Let me know when we are ready to tackle.
Would either of you have anyone within the product group's attention on the behavior outlined in the "Link" when surfaced via Search Results (or a Search based web part like Highlighted Content)? That is, the "Link" attempts to navigate to a "View Document" page, which almost looks like an error or warning. Seems like it should behave more like the "Link to a Document" and navigate the user directly to the linked page/document.
Thank you for your time and reviews here!
-Brian
@brianpmccullough - I just updated the navigation, so your article should show up shortly.
As for the link thing, I'd suggest you post something to the [SharePoint Feedback Portal].(https://feedbackportal.microsoft.com/feedback/forum/06735c62-321c-ec11-b6e7-0022481f8472)