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

u3g.4: increase visibility in apropos and release HW notes #1519

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

concussious
Copy link
Contributor

@concussious concussious commented Nov 7, 2024

Issue: this is not discoverable in apropos or the release hw notes.

This is a small change but kind of a big deal because potential new users come to our social spaces and nobody thinks there's 4g modems so they say they'll stick with $otheros instead for their router project.

  • add cellular and modem to manual document description (apropos search keywords)
  • add cellular and modems to HARDWARE for search in the release hardware notes 1
  • massage introductory sentence because 4G and PCIe modems are existing here (but do they operate over usb?)
  • tag spdx

Unresolved questions, hopefully not obstructing this undocumented documentation bugfix:

  • what is mpd connections? I don't see that in apropos
  • is this ucom thing still the rule or has this aged poorly? How does this relate to ppp? (E.g. not asking for free tech support, asking what I should write to make this page great)

cc @allanjude

Footnotes

  1. Thus, please consider MFC to beta

@concussious concussious changed the title u3g.4: add modem to cellular modem driver page u3g.4: increase visibility in apropos and release HW notes Nov 7, 2024
@concussious
Copy link
Contributor Author

@jlduran maybe?

share/man/man4/u3g.4 Outdated Show resolved Hide resolved
.It
Huawei B190, E180v, E220, E3372, E3372v153, E5573Cs322, ('<Huawei Mobile>')
Huawei B190, E180v, E220, E3372, E3372v153, E5573Cs322, etc.
Copy link
Member

Choose a reason for hiding this comment

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

Does this change lose information? Is Huawei Mobile just a generic company, or some specific branding these are sold under?

Copy link
Contributor Author

@concussious concussious Nov 12, 2024

Choose a reason for hiding this comment

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

When I googled I only found Huawei for each of the model numbers here. They are all sold under the Huawei brand. I think someone will /huawei on the manual or release notes.

share/man/man4/u3g.4 Outdated Show resolved Hide resolved
@concussious
Copy link
Contributor Author

Thank you so much sirs.

Many people come on our social spaces asking about router projects,
can't find info about supported cellular modems, and say they're
sticking to $other_OS. Thanks to the fantastic talk by Ian from
Metify, I now know that is not true, we have them and they work great.

Therefore, tell everyone else by massaging this page for
discoverability in the manual and the release hardware notes.

+ Document description: s/datacards/cellular modems/ for apropos search
+ HARDWARE: s/adapters/cellular modems/ for release hardware notes
+ move things which shouldn't be in Rel HW notes to description
+ massage things around for readability and flow + tag spdx
+ xref supported connections

MFC after:	3 days
Reported by:	Jared Trout <[email protected]> (cellular in title)
Reported by:	emaste (specify mpd, editorial style instruction)
Reported by:	Metify (modem drivers exist)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants