Skip to content

Conversation

@kzu
Copy link
Contributor

@kzu kzu commented Sep 15, 2019

Documents the new behavior in dotnet/sdk#3440

(You can replace all of this text with your description.)

Before creating your pull request, please check your content against these quality criteria:

  • Did you consider search engine optimization (SEO) when you chose the title in the metadata section and the H1 heading (i.e. the displayed title that starts with a single #)?
  • For new articles, did you add it to the table of contents?
  • Did you update the "ms.date" metadata for new or significantly updated articles?
  • Are technical terms and concepts introduced and explained, and are acronyms spelled out on first mention?
  • Should this page be linked to from other pages or Microsoft web sites?

For more information about creating content for docs.microsoft.com, see the contributor guide at https://docs.microsoft.com/contribute/.

@PRMerger18
Copy link
Contributor

@kzu : Thanks for your contribution! The author(s) have been notified to review your proposed change.

@ShannonLeavitt ShannonLeavitt added the aq-pr-triaged tracking label for the PR review team label Sep 16, 2019
@Mikejo5000
Copy link
Collaborator

@rainersigwald for review

@rainersigwald
Copy link
Contributor

Looks ok to me. Two concerns:

  • This functionality is not yet merged, so it doesn't work anywhere (yet!)
  • No mention of what release the functionality is (will be) added in, or that it only works in Microsoft.NET.Sdk projects.

Not sure what the usual docs procedure for such a situation is . . .

cc @livarcocc since Peter has moved on

@Mikejo5000
Copy link
Collaborator

Mikejo5000 commented Sep 17, 2019

For these scenarios, we would need to say something like "Starting in MSBuild <version>, ...."

For SDK-only information, it's critical to mention that or the doc messaging will start to get confusing.

@kzu
Copy link
Contributor Author

kzu commented Sep 17, 2019

Hm... I'm not so sure that page is the right place for this doc... It starts by saying:

In MSBuild, an item is a named reference to one or more files.

But these items (AssemblyMetadata but also #3937 for InternalsVisibleTo) are just metadata, not files. Also, in order to properly document them, I'd need to talk about the assembly info codegen that happens only on SDK-style, and the associated properties that affect that generation. And that would no longer belong to a "Items" discussion.

So maybe what we need is an entirely new document talking about AssemblyInfo codegen in general, what properties and items affect it and how? If we agree that's the better way, I'll close the other docs PR and unify on just one.

@Mikejo5000
Copy link
Collaborator

@rainersigwald for input

@rainersigwald
Copy link
Contributor

I think having a link to SDK docs (possibly not-currently-existing, cc @mairaw) would be reasonable, but I worry about smearing things out into too many places, so I think this is a good place too.

Saying items are files is flat wrong and we should just remove that sentence.

@Mikejo5000
Copy link
Collaborator

@kzu Daniel, could you commit the suggestion? Then we can merge. Thanks!

Co-Authored-By: Mike Jones <mikejo@microsoft.com>
@PRMerger6 PRMerger6 requested a review from Mikejo5000 November 1, 2019 14:01
@PRMerger6
Copy link
Contributor

@kzu : Thanks for your contribution! The author(s) have been notified to review your proposed change.

@kzu
Copy link
Contributor Author

kzu commented Nov 1, 2019

done @Mikejo5000

@Mikejo5000
Copy link
Collaborator

Thanks!

@Mikejo5000
Copy link
Collaborator

#sign-off

@jborsecnik jborsecnik merged commit bac55d5 into MicrosoftDocs:master Nov 1, 2019
@kzu kzu deleted the patch-2 branch November 3, 2019 04:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

aq-pr-triaged tracking label for the PR review team change sent to author ready-to-merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants