Skip to content

Update example paragraph #907

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

Merged
merged 1 commit into from
Jan 17, 2019

Conversation

jarlamsa
Copy link
Contributor

@jarlamsa jarlamsa commented Jan 9, 2019

HTTP part was removed from the example, update also the link to example to point to master.

@jarlamsa
Copy link
Contributor Author

jarlamsa commented Jan 9, 2019

@melwee01 please review

@jarlamsa jarlamsa force-pushed the wifi_interface_update branch from 13e34ae to 750159a Compare January 9, 2019 12:08

The ESP8266Interface uses AT commands over serial interface to connect to an external Wi-Fi device. The OdinWiFiInterface provides an Ethernet-like driver to the Mbed OS network stack. The network stack uses the driver to connect to Wi-Fi:

[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-wifi)](https://github.com/ARMmbed/mbed-os-example-wifi/blob/mbed-os-5.10.0/main.cpp)
[![View code](https://www.mbed.com/embed/?url=https://github.com/ARMmbed/mbed-os-example-wifi)](https://github.com/ARMmbed/mbed-os-example-wifi/blob/master/main.cpp)
Copy link
Contributor

Choose a reason for hiding this comment

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

Is there a 5.11 branch or tag for this example?

Copy link
Contributor

Choose a reason for hiding this comment

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

Does it need to be specifically to 5.11? Master should always point to the latest tag, Seppo says.

Copy link
Contributor

Choose a reason for hiding this comment

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

Because we have versioned code, we must have versioned docs (and therefore, versioned examples). Our development branch can point to master, but our live sites should point to versioned examples. If someone's using Mbed OS 5.8, and we include an example from Mbed OS 5.11, which uses features not in 5.8, it'll be confusing.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

There are 4 different tags for 5.11 for this example, 1 for each RC, but not for the release

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Do we have some automation for updating the tags and links when mbed-os release is done, or is this all manual work?

Copy link
Contributor

Choose a reason for hiding this comment

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

It's all manual work for now, but we've asked the teams revising the examples process to change that.

@melwee01 melwee01 added the docathlon2019 doxygen review label Jan 10, 2019
@AnotherButler AnotherButler merged commit 6d358dc into ARMmbed:development Jan 17, 2019
AnotherButler pushed a commit that referenced this pull request Jan 17, 2019
Apply example changes from #907 to 5.11.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docathlon2019 doxygen review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants