Add VB samples to docs #1977

mrlacey · 2018-04-15T14:02:37Z

Issue: #1865

PR Type

What kind of change does this PR introduce?

Documentation content changes

What is the current behavior?

Code samples are C# only

What is the new behavior?

Code samples for the website are now in C# and VB.Net

PR Checklist

Please check if your PR fulfills the following requirements:

Tested code with current supported SDKs
Docs have been added/updated which fit documentation template. (for bug fixes / features)
Sample in sample app has been added / updated (for bug fixes / features)
- Icon has been created (if new sample) following the Thumbnail Style Guide and templates
Tests for the changes have been added (for bug fixes / features) (if applicable)
Header has been added to all new source files (run build/UpdateHeaders.bat)
Contains NO breaking changes

Other information

I've separately tested with @nmetulev that these changes will create the behavior on the website where a person can choose their preferred language from a menu on the side of the screen and then all samples will switch to that language.

Changes to the code included in the sample app will follow in a separate PR.

Also fixed C# samples to work as listed

And fixed some errors in C# samples Also fixed some typos

Also some typo fixes

Also fixed some typos and standardized spacing around codeblocks

…VBSamplesToDocs

nmetulev · 2018-04-15T21:11:40Z

ping @Vijay-Nirmal for review

nmetulev

Tested on docs and works as expected:

Tested in sample app and works as expected.

Other than the comments below, looks amazing. And thank you for fixing few code blocks and so many typos :)

nmetulev · 2018-04-15T21:25:28Z

docs/animations/AnimationSet.md

@@ -35,6 +38,12 @@ anim.SetDurationForAll(2500);
 anim.SetDelay(250);
 anim.Start();
 ```
+```vb


The XAML and C# titles should be removed since each code block already specifies the language.

@Vijay-Nirmal, should this be done in your PR?

nmetulev · 2018-04-15T21:38:47Z

docs/services/Twitter.md

+' Open a connection with the stream service in order to receive live tweets and events
+ListView.ItemsSource = _tweets
+Await TwitterService.Instance.StartUserStreamAsync(Async Sub(tweet)
+														Await Dispatcher.RunAsync(CoreDispatcherPriority.Normal, Sub()


Is this normal to be indented like this?

VS auto indents like this. If it's unreadable on the docs site I can try and reformat.

This is how it looks like on docs:

It's readable, but not ideal.

fix submitted

Vijay-Nirmal

Looks good. Update .template.md file.

This PR should be open untill #1748 because that PR has some C# code.

nmetulev · 2018-04-27T05:43:39Z

Now that #1748 is merged, I think we can proceed with this PR. @mrlacey, once you resolve conflicts we should be good to go to merge.

…VBSamplesToDocs # Conflicts: # docs/animations/AnimationSet.md # docs/animations/FadeHeader.md # docs/animations/Saturation.md # docs/controls/BladeView.md # docs/controls/Carousel.md # docs/controls/HamburgerMenu.md # docs/controls/InAppNotification.md # docs/controls/RangeSelector.md # docs/helpers/AdvancedCollectionView.md # docs/helpers/BackgroundTaskHelper.md # docs/helpers/Colors.md # docs/helpers/DeepLinkParsers.md # docs/helpers/HttpHelper.md # docs/helpers/HttpHelperRequest.md # docs/helpers/HttpHelperResponse.md # docs/helpers/PrintHelper.md # docs/helpers/StorageFiles.md # docs/helpers/Streams.md # docs/services/Bing.md # docs/services/Facebook.md # docs/services/Linkedin.md # docs/services/MicrosoftGraph.md # docs/services/OneDrive.md # docs/services/Twitter.md

mrlacey · 2018-04-27T13:11:19Z

@nmetulev merge issues addressed and I've added VB versions of the new C# samples too

Vijay-Nirmal · 2018-04-28T06:41:38Z

@mrlacey Update .template.md file with the info to add VB codes.

nmetulev · 2018-04-30T01:16:25Z

Looks good. Agree with @Vijay-Nirmal, should update the template with guidance around adding VB code, can you add it @mrlacey ?

Plus, fixed a couple of other typos

mrlacey · 2018-04-30T09:18:57Z

Looks good. Agree with @Vijay-Nirmal, should update the template with guidance around adding VB code, can you add it @mrlacey ?

I've updated the template as I feel is appropriate.
In WTS we make including VB support/docs optional as it's seen as a barrier to contribution from devs who only do C#. We use a script/manual process to identify gaps and inconsistencies in the different language support and address those separately. Not sure how you want to handle this in the toolkit though.

nmetulev · 2018-04-30T16:03:51Z

Good point. How about we add a comment above the VB code block specifying that it is optional and ask the developer to add the dev lang at the top if they include VB?

mrlacey · 2018-04-30T19:25:42Z

@nmetulev the comment I added to the template was

nmetulev · 2018-04-30T20:15:41Z

If we want to make it more optional, we should ask the developer to add the - vb instead of asking everyone to remove it, what do you think?

mrlacey · 2018-04-30T21:14:06Z

@nmetulev I've updated the template to make VB samples optional. Is this more in line with what you were thinking?

windowstoolkitbot · 2018-04-30T23:35:33Z

This PR is linked to unclosed issues. Please check if one of these issues should be closed: #1865

nmetulev · 2018-04-30T23:35:42Z

Perfect, thank you, merged :)

mrlacey added 11 commits March 7, 2018 15:41

stream & themelistener helpers

6ce66a4

Adding other 'Helper' files

29e3754

corectly indicate code samples in different languages

41b59a3

Parsers

b39005a

Also fixed C# samples to work as listed

VisualTreeExtensions VB docs

67b3c11

Add VB samples to Animations docs

696f21f

And fixed some errors in C# samples Also fixed some typos

Add VB samples to Controls docs

6763ee2

Also some typo fixes

Add VB samples to Services docs

d1a679d

Also fixed some typos and standardized spacing around codeblocks

ensure consistent language indicator use

4f71d16

Merge remote-tracking branch 'refs/remotes/Microsoft/master' into Add…

6c904cb

…VBSamplesToDocs

Add VB version of new PrintHelper docs code

bb877de

nmetulev requested changes Apr 15, 2018

View reviewed changes

nmetulev added documentation 📃 reviewers wanted labels Apr 15, 2018

nmetulev added this to the 3.0 milestone Apr 15, 2018

Vijay-Nirmal suggested changes Apr 16, 2018

View reviewed changes

Reformatted long code line in twitter doc

290dc0d

mrlacey added 2 commits April 27, 2018 13:55

Adding missing VB samples

9089315

nmetulev approved these changes Apr 30, 2018

View reviewed changes

Added VB placeholder to template.md

c86be39

Plus, fixed a couple of other typos

Vijay-Nirmal approved these changes Apr 30, 2018

View reviewed changes

Make VB samples optional in the template

8023f4c

nmetulev merged commit c53293a into CommunityToolkit:master Apr 30, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add VB samples to docs #1977

Add VB samples to docs #1977

mrlacey commented Apr 15, 2018

nmetulev commented Apr 15, 2018

nmetulev left a comment

nmetulev Apr 15, 2018 •

edited

Loading

Vijay-Nirmal Apr 16, 2018

Vijay-Nirmal Apr 17, 2018

nmetulev Apr 15, 2018

mrlacey Apr 16, 2018

nmetulev Apr 16, 2018

mrlacey Apr 16, 2018

Vijay-Nirmal left a comment

nmetulev commented Apr 27, 2018

mrlacey commented Apr 27, 2018

Vijay-Nirmal commented Apr 28, 2018

nmetulev commented Apr 30, 2018

mrlacey commented Apr 30, 2018

nmetulev commented Apr 30, 2018

mrlacey commented Apr 30, 2018

nmetulev commented Apr 30, 2018 •

edited

Loading

mrlacey commented Apr 30, 2018

windowstoolkitbot commented Apr 30, 2018

nmetulev commented Apr 30, 2018

Add VB samples to docs #1977

Add VB samples to docs #1977

Conversation

mrlacey commented Apr 15, 2018

PR Type

What is the current behavior?

What is the new behavior?

PR Checklist

Other information

nmetulev commented Apr 15, 2018

nmetulev left a comment

Choose a reason for hiding this comment

nmetulev Apr 15, 2018 • edited Loading

Choose a reason for hiding this comment

Vijay-Nirmal Apr 16, 2018

Choose a reason for hiding this comment

Vijay-Nirmal Apr 17, 2018

Choose a reason for hiding this comment

nmetulev Apr 15, 2018

Choose a reason for hiding this comment

mrlacey Apr 16, 2018

Choose a reason for hiding this comment

nmetulev Apr 16, 2018

Choose a reason for hiding this comment

mrlacey Apr 16, 2018

Choose a reason for hiding this comment

Vijay-Nirmal left a comment

Choose a reason for hiding this comment

nmetulev commented Apr 27, 2018

mrlacey commented Apr 27, 2018

Vijay-Nirmal commented Apr 28, 2018

nmetulev commented Apr 30, 2018

mrlacey commented Apr 30, 2018

nmetulev commented Apr 30, 2018

mrlacey commented Apr 30, 2018

nmetulev commented Apr 30, 2018 • edited Loading

mrlacey commented Apr 30, 2018

windowstoolkitbot commented Apr 30, 2018

nmetulev commented Apr 30, 2018

nmetulev Apr 15, 2018 •

edited

Loading

nmetulev commented Apr 30, 2018 •

edited

Loading