-
Notifications
You must be signed in to change notification settings - Fork 554
Synchronize back docs moved to https://docs.microsoft.com #3771
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
Work in progress (there's more docs to sync). @bradumbaugh please double check - it's largely your changes over our own @chamons we need to fix 2100 for mmp :( |
|
@spouliot Looks good. One change request: please put internal anchors such as This: Instead of: |
|
Blah. At least 2100 is a simple error code. Patch in a second. |
|
@spouliot Made an update above - I'd mistakenly left off a space after the # character. |
|
@spouliot https://git.io/vxmHH should work for 2100 |
|
@chamons please PR that on master but without |
|
On it. |
|
@bradumbaugh not sure I follow, there's no change for MT0055, i.e. https://github.com/xamarin/xamarin-macios/pull/3771/files#diff-656045af32acf6dda51d8e5dd079d5e2L238 or are you suggest a global change ? The first commit is only a merge back from the version in IOW this PR is only so we don't overwrite your changes (in |
|
@spouliot Yes, I'm suggesting a global change for that doc. The current doc is going through a localization process that requires the anchors to be placed as I've described above, so that's a change that's in-process. [edit] @spouliot If you'd like to wait until we have the change in the docs repository before making it here, that's fine - but we'll still need to circle back. Apologies for the confusion. |
|
#3773 for the 2100 fixes |
|
@bradumbaugh whats the timeline for the localization change ? |
|
@spouliot about #3768 (comment), you didn't fix |
VincentDondain
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM except we should also fix MM0132 🙏
|
@spouliot I will make the necessary change and reply back today. |
|
@spouliot The changes to anchors we discussed last week are in now in the master in the docs repo. |
|
Build failure |
Build success
|
|
@dalexsoto please review, in particular the binding documents (to make sure I did not miss anything you added). @bradumbaugh one, hopefully, final review please :) |
Build success
|
Build failure
|
|
Failures are unrelated, something went wrong with 32bits sim/contact authorization -> https://github.com/xamarin/maccore/issues/737 |
dalexsoto
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 👍
bradumbaugh
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@spouliot Went through these changes, compared them to master, did a test publish to make sure things rendered correctly. A few changes requested - all pretty minor.
| ### DesignatedDefaultCtorAttribute | ||
|
|
||
| When this attribute is applied to the interface definition it will generate | ||
| a `[DesignatedInitializer]` attribute on the default (generated) constructor |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
add a comma after "default (generated) constructor"
| ``` | ||
|
|
||
| When the `WrapAttribute` is used inside a `Category` you need to include `This` as | ||
| When the `[WrapAttribute]` is used inside a `Category` you need to include `This` as |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Should "Category" be "[Category]" here?
- Should "This" be lowercase?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes, it should be (in order of preference) [Category] or CategoryAttribute or [CategoryAttribute]
This is correct in this wrapped context
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I re-worded the paragraph to explain why. Please review it again :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good.
|
|
||
| When the `WrapAttribute` is used inside a `Category` you need to include `This` as | ||
| When the `[WrapAttribute]` is used inside a `Category` you need to include `This` as | ||
| the first argument inside the `Wrap` signature, for example: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
change to: "signature. For example:"
| ## RequiresSuperAttribute | ||
| ### RequiresSuperAttribute | ||
|
|
||
| This is a specialized subclass of the `[Advice]` attribute can be used |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
that can be used
| ### RequiresSuperAttribute | ||
|
|
||
| This is a specialized subclass of the `[Advice]` attribute can be used | ||
| to hint the developer that overriding a method **requires** a call to |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
to the developer
docs/website/xamarin-ios-analysis.md
Outdated
| title: Xamarin.iOS Analysis Rules | ||
| dateupdated: 2018-02-15 | ||
| title: "Xamarin.iOS analysis rules" | ||
| ms.topic: article |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
change to:
ms.topic: troubleshooting
| - **Fix:** Double click on your iOS project, go to Build > iOS Build and for Release|iPhone, check the LLVM optimizing compiler option. | ||
| ## XIA0007: UseLLVMRule | ||
|
|
||
| - **Problem:** For Release|iPhone configuration we recommend enabling the LLVM compiler which generates code that is faster to execute at the expense of build time. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
**Release|iPhone**(bold)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It would be nicer but that text is extracted (by a tool) from Xamarin.iOS.Analysis.targets and it's shown in UI in places where markdown does not apply. IOW it cannot be applied to it's origin and will come back unformatted each time.
| ## XIA0007: UseLLVMRule | ||
|
|
||
| - **Problem:** For Release|iPhone configuration we recommend enabling the LLVM compiler which generates code that is faster to execute at the expense of build time. | ||
| - **Fix:** Double click on your iOS project, go to Build > iOS Build and for Release|iPhone, check the LLVM optimizing compiler option. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
**Build > iOS Build**(bold)**Release|iPhone**
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
same
docs/website/Makefile
Outdated
| all: xamarin-analysis-doc | ||
| cp mtouch-errors.md $(WEBSITE_DOCS)/guides/ios/troubleshooting/mtouch-errors/index.md | ||
| cp mtouch-errors.md $(WEBSITE_DOCS)/docs/ios/troubleshooting/mtouch-errors.md | ||
| cp binding_objc_libs.md $(WEBSITE_DOCS)/guides/cross-platform/macios/binding/objective-c-libraries/index.md |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This document lives at:
docs/cross-platform/macios/binding/objective-c-libraries.md
docs/website/Makefile
Outdated
| cp xamarin-ios-analysis.md $(WEBSITE_DOCS)/guides/ios/troubleshooting/xamarin-ios-analysis/index.md | ||
| cp binding_types_reference_guide.md $(WEBSITE_DOCS)/docs/cross-platform/macios/binding/binding-types-reference.md | ||
| cp xamarin-ios-analysis.md $(WEBSITE_DOCS)/ios/troubleshooting/xamarin-ios-analysis.md | ||
| cp optimizations.md $(WEBSITE_DOCS)/guides/cross-platform/macios/build-optimizations/index.md |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't see this doc in the existing docs.microsoft.com TOC...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
optimizations.md is new in 15.7. IIRC we discussed it with you a few week (months now?) back. c.c. @rolfbjarne
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I created a PR for the documentation repo, which was postponed until the move to docs.microsoft.com: https://github.com/xamarin/documentation/pull/2845
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Right - apologies for missing this. I'll look at adding this content today.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
since it's new in 15.7 so it can wait for the release (since it won't be usable content until then)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sounds good, I'll just get it ready.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PR here for build optimizations (waiting for 15.7 to merge): https://github.com/MicrosoftDocs/xamarin-docs-pr/pull/204
|
@spouliot One further question - @VincentDondain requested that we also publish https://github.com/xamarin/xamarin-macios/blob/master/docs/website/generator-errors.md. It will require similar changes to the anchors, etc. Should we include that as part of this PR or wait until it is published before doing so? |
|
@bradumbaugh for generator-errors.md we'll wait for 15.8 since we'll want IDE support (double click to error) and beside being too late for 15.7 we will do it "one page per error" from day one :) |
bradumbaugh
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Need to update the Makefile for the location of the build optimizations doc (hasn't been merged yet, but the Makefile is inconsistent with its future location)
docs/website/Makefile
Outdated
| cp xamarin-ios-analysis.md $(WEBSITE_DOCS)/guides/ios/troubleshooting/xamarin-ios-analysis/index.md | ||
| cp binding_types_reference_guide.md $(WEBSITE_DOCS)/docs/cross-platform/macios/binding/binding-types-reference.md | ||
| cp xamarin-ios-analysis.md $(WEBSITE_DOCS)/ios/troubleshooting/xamarin-ios-analysis.md | ||
| cp optimizations.md $(WEBSITE_DOCS)/guides/cross-platform/macios/build-optimizations/index.md |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Staged the build optimizations content in a PR here: https://github.com/MicrosoftDocs/xamarin-docs-pr/pull/204.
Build optimizations will live here:
docs/cross-platform/macios/optimizations.md
docs/website/Makefile
Outdated
| -diff -u $(WEBSITE_DOCS)/docs/cross-platform/macios/binding/objective-c-libraries.md binding_objc_libs.md | ||
| -diff -u $(WEBSITE_DOCS)/docs/cross-platform/macios/binding/binding-types-reference.md binding_types_reference_guide.md | ||
| -diff -u $(WEBSITE_DOCS)/docs/ios/troubleshooting/xamarin-ios-analysis.md xamarin-ios-analysis.md | ||
| -diff -u $(WEBSITE_DOCS)/docs/cross-platform/macios/build-optimizations/index.md optimizations.md |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same as above; build optimizations doc will live here:
docs/cross-platform/macios/optimizations.md
Build failure
|
Build success
|
No description provided.