This repository has been archived by the owner on Mar 14, 2024. It is now read-only.

Convert Web Bluetooth article from WebFu #4090

Merged

kaycebasques merged 2 commits into GoogleChrome:master from beaufortfrancois:bluetooth

Oct 21, 2020

Member

beaufortfrancois commented Oct 19, 2020 •

edited

This PR is about moving https://developers.google.com/web/updates/2015#interact_with_bluetooth_devices_on_the_web to web.dev/bluetooth

Changes to the original article include:

Removed all mentions of the Physical Web and Eddystone as both projects have been cancelled
Replaced "the chrome team" with "spec authors"
Removed lengthy "why https is important" explanation
Replaced "var" and "let" with "const" when possible in JS examples
Removed "flying grumpy cats" as YouTube video is down nowadays
Updated all bluetooth.com links as the viewer has been removed
Replaced all 404 URLs with new ones.

Live preview at https://deploy-preview-4090--web-dev-staging.netlify.app/bluetooth/

beaufortfrancois requested a review from a team as a code owner

October 19, 2020 18:45

beaufortfrancois requested review from kaycebasques and jpmedley

October 19, 2020 18:45

google-cla bot added the cla: yes label

github-actions bot commented Oct 19, 2020

Alex Recommends Report

Alex recommends the following language changes, but Alex is a regular expression based algorithm, so take them with a grain of salt.

✨ 🚀 ✨ Nothing to Report ✨ 🚀 ✨

beaufortfrancois mentioned this pull request

Add devices learning area #3980

Merged

netlify bot commented Oct 19, 2020 •

edited

Deploy preview for web-dev-staging ready!

Built with commit 975ab28

https://deploy-preview-4090--web-dev-staging.netlify.app

beaufortfrancois force-pushed the bluetooth branch from aa1038e to 51e3f46 Compare

October 20, 2020 06:28

beaufortfrancois added the CDS 2020 label


          Convert Web Bluetooth article from WebFu

b11f02d

beaufortfrancois force-pushed the bluetooth branch from 51e3f46 to b11f02d Compare

October 20, 2020 09:45

kaycebasques suggested changes

View reviewed changes

Contributor

kaycebasques left a comment •

edited

@jpmedley may still want to review this, but I figured I could do a review so that Francois can update this and the USB pages while we're asleep.

@beaufortfrancois I'm sure you're aware, but the batch commit suggestion workflow should help you address my requested changes faster.

Joe, I know this is your swimlane, but Francois was waiting on me to review the Devices collection for a long time and I wanted to make it up to him, so I figured I'd do a review of this to attempt to land this Bluetooth page and the USB page faster. Also, all of my comments are fairly routine so I don't think there will be a "too many cooks in the kitchen" situation.

src/site/content/en/blog/bluetooth/index.md

+                - beaufortfrancois
+              date: 2015-07-21
+              updated: 2020-10-19
+              hero: hero.jpg

Contributor

kaycebasques Oct 20, 2020

Hmm. This looks very grainy for me. I see that it's the correct dimensions. Maybe it was smaller than 3200 and resized up? In other words, can you find a higher resolution version?

Member Author

beaufortfrancois Oct 21, 2020

I've found the original image, updated it, and added proper attribution.
Thanks for catching!

src/site/content/en/blog/bluetooth/index.md Outdated

+              Bluetooth devices: status, services, characteristics, and descriptors.
+              <figure class="w-figure">
+                <img src="./bluetooth-internals.png" class="w-screenshot" alt="Screenshot of the internal page to debug Bluetooth in Chrome">

Contributor

kaycebasques Oct 20, 2020

Please resize this to 1600 pixels width

Member Author

beaufortfrancois Oct 21, 2020

Squooshed!

src/site/content/en/blog/bluetooth/index.md Outdated

		@@ -0,0 +1,549 @@
		---
		title: Communicating with Bluetooth devices

Contributor

kaycebasques Oct 20, 2020

Suggested change

      
            title: Communicating with Bluetooth devices
          
            title: Communicating with Bluetooth devices over JavaScript

Title keywords seem to have a big impact on documentation SEO. In my own experience, if I'm searching for how to do this, I think I would append js or javascript to my search query. You're welcome to rephrase this however you see fit, but I think we should try to get a keyword or two in here to make it clear that the guidance is for web developers. Especially since a lot of different developers have a need to communicate with Bluetooth devices (firmware developers, etc.)

Member Author

beaufortfrancois Oct 21, 2020

Done.

src/site/content/en/blog/bluetooth/index.md

+              tags:
+                - blog # blog is a required tag for the article to show up in the blog.
+                - capabilities
+                - devices

Contributor

kaycebasques Oct 20, 2020

Suggested change

      
              - devices
          
              - devices
          
              - iot

We have an IoT tag [1] listed in our tags metadata file. Do we want to support that or should we get rid of it? It doesn't look like we've used it yet [2]

[1] https://github.com/GoogleChrome/web.dev/blob/master/src/site/_data/tagsData.json#L117
[2] https://web.dev/tags/iot/

Member Author

beaufortfrancois Oct 21, 2020

I would get rid of it.

src/site/content/en/blog/bluetooth/index.md Outdated

+              What if I told you websites could communicate with nearby Bluetooth devices
+              in a secure and privacy-preserving way? This way, heart rate monitors, singing
+              lightbulbs, [turtles] could interact directly with a website.

Contributor

kaycebasques Oct 20, 2020

Suggested change

      
            lightbulbs, [turtles] could interact directly with a website.
          
            lightbulbs, and even [turtles] could interact directly with a website.

We definitely need and in here. I added even because it seemed to match your tone.

Member Author

beaufortfrancois Oct 21, 2020

Done.

src/site/content/en/blog/bluetooth/index.md Outdated


		## Dev Tips

		A "Bluetooth Internals" page is available in Chrome at

Contributor

kaycebasques Oct 21, 2020

Suggested change

      
            A "Bluetooth Internals" page is available in Chrome at
          
            A **Bluetooth Internals** page is available in Chrome at

https://developers.google.com/style/ui-elements#formatting

Member Author

beaufortfrancois Oct 21, 2020

Done

src/site/content/en/blog/bluetooth/index.md Outdated

Comment on lines 472 to 473

		I would also recommend you check out the official ["How to file Web Bluetooth
		bugs"] page as debugging Bluetooth can be hard sometimes.

Contributor

kaycebasques Oct 21, 2020

Suggested change

      
            I would also recommend you check out the official ["How to file Web Bluetooth
          
            bugs"] page as debugging Bluetooth can be hard sometimes.
          
            I also recommend checking out the official [How to file Web Bluetooth
          
            bugs] page as debugging Bluetooth can be hard sometimes.

Quotes around the link are not needed

Member Author

beaufortfrancois Oct 21, 2020

Done

src/site/content/en/blog/bluetooth/index.md

+              I would also recommend you check out the official ["How to file Web Bluetooth
+              bugs"] page as debugging Bluetooth can be hard sometimes.
+              ## What's next

Contributor

kaycebasques Oct 21, 2020

Is this status still up-to-date?

Member Author

beaufortfrancois Oct 21, 2020

Weirdly enough it is actually ;)

src/site/content/en/blog/bluetooth/index.md Outdated

+                event will fire when any characteristic and/or descriptor gets added or
+                removed from a Bluetooth GATT Service.
+              {% YouTube '_BUwOBdLjzQ' %}

Contributor

kaycebasques Oct 21, 2020

Linking to a video from 2015 in a section called Whats next? sends a strange message. I'm OK with embedding the video, but perhaps you want to move it to a different section?

Member Author

beaufortfrancois Oct 21, 2020

I've moved it between resources and new acknowledgments section

src/site/content/en/blog/bluetooth/index.md Outdated

+              - Stack Overflow: [https://stackoverflow.com/questions/tagged/web-bluetooth](https://stackoverflow.com/questions/tagged/web-bluetooth)
+              - Chrome Feature Status: [https://www.chromestatus.com/feature/5264933985976320](https://www.chromestatus.com/feature/5264933985976320)
+              - Implementation Bugs: [https://crbug.com/?q=component:Blink>Bluetooth](https://crbug.com/?q=component:Blink>Bluetooth)

Contributor

kaycebasques Oct 21, 2020

Suggested change

      
            - Implementation Bugs: [https://crbug.com/?q=component:Blink>Bluetooth](https://crbug.com/?q=component:Blink>Bluetooth)
          
            - Chrome Implementation Bugs: [https://crbug.com/?q=component:Blink>Bluetooth](https://crbug.com/?q=component:Blink>Bluetooth)

Member Author

beaufortfrancois Oct 21, 2020

Done


          Address @kaycebasques feedback

975ab28

Member Author

beaufortfrancois commented Oct 21, 2020

@beaufortfrancois I'm sure you're aware, but the batch commit suggestion workflow should help you address my requested changes faster.

FYI I still manually need to adjust the formatting as I'm trying to keep a consistent maximum number of characters per line.

beaufortfrancois mentioned this pull request

Convert WebUSB article from WebFu #4095

Merged

kaycebasques approved these changes

View reviewed changes

Contributor

kaycebasques left a comment

Looks like we're good here, thanks for migrating @beaufortfrancois

kaycebasques merged commit 9b5b136 into GoogleChrome:master

kaycebasques mentioned this pull request

Launch devices collection #4119

Closed

beaufortfrancois added the content update label

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.