Xamarin-macios: Publish mmp-errors.md and generator-errors.md documentation

Created on 16 Mar 2018  路  14Comments  路  Source: xamarin/xamarin-macios

We only move mtouch-errors to the documentation and therefore publish them to the world.

It seems we don't have a public page for the mmp ones.

Also as a side note: when we do we'll need the VS/VSMac integration.

enhancement iOS macOS

Most helpful comment

@spouliot @VincentDondain I think we should put them under "Troubleshooting," as that's where they are in the iOS repo. Will get set up for that and let you know, since it's a new item in the TOC.

All 14 comments

That should likely be an issue in the docs repo.

c.c. @bradumbaugh for the locations

@spouliot @VincentDondain I think we should put them under "Troubleshooting," as that's where they are in the iOS repo. Will get set up for that and let you know, since it's a new item in the TOC.

@spouliot @VincentDondain @chamons

  • Created a branch in the docs repo for this work: brumbaug-mac-troubleshooting
  • Took the current version of mmp-errors.md and put it on this branch; also updated anchor formatting for docs.microsoft.com
  • Didn't update the bug tracking information, because I'm unclear if I can safely edit those messages or not

Feel free to make any changes you need... will hold off on merging until you've had a chance to edit, etc.

@bradumbaugh it's not ideal since you took master (and not the released d15-6) but it's better than not having it published :) Let's merge this one and we'll start updating it with 15.8 (which will be an update from master)

@spouliot It's easy for me to take a different one - happy to grab the 15.6 version and re-apply the changes that I made.

Put together a PR for this work.

@VincentDondain Sorry, missed this. Are these Mac-specific or iOS-specific? Or relevant to both?

@bradumbaugh relevant to both (:

Hi,

@conceptdev This is still a problem we're facing today and we really should publish the generator errors (there's an argument to be made that we should split them into individual issues first).

In https://github.com/xamarin/xamarin-macios/issues/5260 the customer got a BI1014 issue and no way to access the extra bit of documentation we provide in that document: https://github.com/xamarin/xamarin-macios/blob/master/docs/website/generator-errors.md#bi1014-unsupported-type-for-fields--for-. In addiction we cannot have IDE support for BI errors (where we redirect to the doc when double clicking on the issue) if we don't publish the document first.

@VincentDondain it would be great to have all the error messages published, like the c# errors are (source). Splitting them up would help enormously with discoverability/navigation, and make direct links easier/more reliable.

@conceptdev it's still the plan, ref: https://github.com/xamarin/xamarin-macios/issues/3570 but we have not gotten to it yet
It seems like starting the "new" binding errors that way could be a stepping stone before converting the existing ones

Was this page helpful?
0 / 5 - 0 ratings