Skip to content
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

[docs] Reorganize public Documentation #8889

Merged
merged 2 commits into from
Apr 23, 2024

Conversation

jonpryor
Copy link
Member

Context: https://learn.microsoft.com/dotnet/android
Context: https://github.com/dotnet/docs-mobile
Context: https://dotnet.microsoft.com/en-us/platform/support/policy/xamarin

Support for Xamarin.Android ends on 2024-May-1.

Along with end of support, documentation for Xamarin.Android will be de-listed: the content will still be there, but search will not return results within it, and search engines will not find it.

Meaning that after May-1 there will be no documentation for error and warning messages such as XA0000.

We now have a new documentation site for .NET for Android, https://learn.microsoft.com/dotnet/android!

This new site takes content from
https://github.com/dotnet/docs-mobile, which isn't currently public, but we are in the process of making it public.

Meanwhile, the Documentation directory was always intended to be a source of some documentation, so that documentation for new features could exist concurrent with the commit introducing the feature. This is not a workflow we wish to change.

To make synchronization easier, create a new
Documentation/docs-mobile directory which mirrors the contents of docs-mobile/docs/android, and migrate over our existing docs into the new directory structure.

Context: https://learn.microsoft.com/dotnet/android
Context: https://github.com/dotnet/docs-mobile
Context: https://dotnet.microsoft.com/en-us/platform/support/policy/xamarin

Support for Xamarin.Android ends on 2024-May-1.

Along with end of support, *documentation* for Xamarin.Android will
be *de-listed*: the content will still be there, but search will not
return results within it, and search engines will not find it.

Meaning that after May-1 there will be no documentation for error and
warning messages such as XA0000.

We now have a new documentation site for .NET for Android,
<https://learn.microsoft.com/dotnet/android>!

This new site takes content from
<https://github.com/dotnet/docs-mobile>, which isn't currently public,
but we are in the process of making it public.

Meanwhile, the `Documentation` directory was always intended to be
a source of *some* documentation, so that documentation for new
features could exist concurrent with the commit introducing the
feature.  This is not a workflow we wish to change.

To make synchronization easier, create a new
`Documentation/docs-mobile` directory which mirrors the contents of
[docs-mobile/docs/android][0], and migrate over our existing docs
into the new directory structure.

[0]: https://github.com/dotnet/docs-mobile/tree/main/docs/android
Comment on lines -130 to +126
to [initialize environment variables and system properties during process startup](~/android/deploy-test/environment.md).
to [initialize environment variables and system properties during process startup](/xamarin/android/deploy-test/environment).
Copy link
Member

Choose a reason for hiding this comment

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

I don't know how the sync thing works, but this links to an old Xamarin doc?

So, we'd plan on moving this doc at some point?

Copy link
Member Author

Choose a reason for hiding this comment

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

I didn't want to take the time to migrate over every URL that mentioned /xamarin, and as the old /xamarin/android docs are only being delisted and not removed, I figured that this would be acceptable for now.

Mid-to-long term, yes, we should migrate over the referenced documentation so that everything lives within /dotnet/android.

Note that nothing in the open source xamarin-android repository
emits ADB0010, as features such as debugging and "fast deployment"
are implemented in the proprietary Xamarin.Android additions.
Note that nothing in the open source <https://github.com/xamarin/xamarin-android>
Copy link
Member

Choose a reason for hiding this comment

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

Is this supposed to be a markdown link? Or are we really wanting the text <https://github.com/xamarin/xamarin-android> to show?

Copy link
Member

Choose a reason for hiding this comment

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

This is in here a couple other times.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, that's supposed to be a Markdown link; see rendered: https://learn.microsoft.com/en-us/dotnet/android/messages/adb0010

Note that nothing in the open source https://github.com/xamarin/xamarin-android repository emits ADB0010, …

I think there are two implied questions here:

  1. Should we be mentioning it here?
  2. Should we even be mentioning xamarin/xamarin-android, anywhere?

Regarding (1), perhaps not: it's likely extraneous information that doesn't really help anybody, and thus we should consider removing the ## Implementation notes sections from all the adb* messages.

Regarding (2), it is the current repo location (though we want to do that around June…), and it does make sense to mention it when relevant, e.g. in xa0107.md:

Consider submitting a [bug](https://github.com/xamarin/xamarin-android/wiki/Submitting-Bugs,-Feature-Requests,-and-Pull-Requests)
if you are getting this warning under normal circumstances.                                                                  

We could consider creating an aka.ms shortlink instead of directly linking to the repo.

That, there are also the Release notes, which directly link to xamarin/xamarin-android and are directly mentioned in TOC.yml (if not yet rendered), and we likely don't want to create short links for each one of those…

Copy link
Member

@jonathanpeppers jonathanpeppers left a comment

Choose a reason for hiding this comment

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

I think PoliCheck wants one phrase reworded:

Tool: PoliCheck: Rule: 185837 (Term: Oriya. TermClass: Geopolitical. Action: Action : Context = When used to refer to the language spoken in India and/or the script in which it is written in modern contexts.; ActionRecommendation = <b>REPLACE WITH</b> "Odia"; Context = When used to reference the Unicode block, code chart, or names of individual characters or code points.; ActionRecommendation = <b>Leave term unchanged</b>; ). 
Term: 'Oriya'. Term class: Geopolitical. Term table: en-9. Position: Line: 1643. Context(term at 34): '  \[x-iscii-as, CP57006\], *ISCII Oriya* \[x-iscii-or, CP57007\],'.

@jonpryor
Copy link
Member Author

@jonathanpeppers wrote:

I think PoliCheck wants one phrase reworded:

Tool: PoliCheck: Rule: 185837 (Term: Oriya. TermClass: Geopolitical. Action: Action : Context = When used to refer to the language spoken in India and/or the script in which it is written in modern contexts.; ActionRecommendation = <b>REPLACE WITH</b> "Odia"; Context = When used to reference the Unicode block, code chart, or names of individual characters or code points.; ActionRecommendation = <b>Leave term unchanged</b>; ). 
Term: 'Oriya'. Term class: Geopolitical. Term table: en-9. Position: Line: 1643. Context(term at 34): '  \[x-iscii-as, CP57006\], *ISCII Oriya* \[x-iscii-or, CP57007\],'.

The warning itself states:

Context = When used to reference the Unicode block, code chart, or names of individual characters or code points.; ActionRecommendation = Leave term unchanged;

This usage is in reference to the Unicode block, and thus (in theory) should be left unchanged.

That said, is the $(MandroidI18n) property even supported? Does it do anything anymore?

@jonathanpeppers
Copy link
Member

I don't think $(MandroidI18n) actually does anything, as that would be in implemented in dotnet/runtime now. (They would use a different property if anything like it exists)

@jonpryor
Copy link
Member Author

@jonpryor jonpryor merged commit 5915027 into main Apr 23, 2024
46 of 48 checks passed
@jonpryor jonpryor deleted the dev/jonp/jonp-docs-mobile-sync-2024-apr-19 branch April 23, 2024 20:50
grendello added a commit that referenced this pull request Apr 24, 2024
* main:
  [docs] Reorganize public Documentation (#8889)
  Bump external/Java.Interop from `06214ff` to `6cfa78c` (#8879)
  Localized file check-in by OneLocBuild Task (#8894)
  $(AndroidPackVersionSuffix)=preview.5; net9 is 34.99.0.preview.5 (#8896)
grendello added a commit that referenced this pull request Apr 25, 2024
* main: (26 commits)
  [Mono.Android] fix potential leak of RunnableImplementors (#8900)
  [build] Bump $(AndroidNetPreviousVersion) to 34.0.95 (#8898)
  [docs] Reorganize public Documentation (#8889)
  Bump external/Java.Interop from `06214ff` to `6cfa78c` (#8879)
  Localized file check-in by OneLocBuild Task (#8894)
  $(AndroidPackVersionSuffix)=preview.5; net9 is 34.99.0.preview.5 (#8896)
  Bump to xamarin/monodroid@a5742221b3 (#8893)
  Remove MonoArchive_BaseUri from Configurables.cs (#8890)
  Bump to xamarin/xamarin-android-binutils/L_18.1.4-8.0.0@758d2e7 (#8885)
  [Mono.Android] Bind API-VanillaIceCream Beta 1 (#8891)
  [AndroidToolTask] Log tool output as error  (#8861)
  [Xamarin.Android.Build.Tasks] Remove "Xamarin" from messages (#8884)
  [Mono.Android] Bind API-VanillaIceCream Developer Preview 2 (#8741)
  Bump to dotnet/installer@22ffa42d6c 9.0.100-preview.4.24221.5 (#8887)
  Bump external/xamarin-android-tools from `37d79c9` to `05f9a90` (#8869)
  Bump external/Java.Interop from `e1c7832` to `06214ff` (#8878)
  Bump to dotnet/installer@7380c301c1 9.0.100-preview.4.24215.2 (#8874)
  [Mono.Android] Commit baseline PublicAPI files for API-35 (#8840)
  Add a unit test to check environment processing (#8856)
  Don't use azureedge.net CDN (#8846)
  ...
@github-actions github-actions bot locked and limited conversation to collaborators May 24, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants