Feature Request: Search for proper names and turn them into substitution strings

[johnwalicki]

Is your feature request related to a problem? Please describe.

If / when the documentation is translated, we don't want proper names, trademarks to be translated. Words like Intel, Fedora, MacOS, IBM Cloud,

The Open Horizon Documentation repo adds these words to a keyword file at https://github.com/open-horizon/open-horizon.github.io/blob/master/_data/keyword.yml

In the Markdown .md files, the keywords are marked eg {{site.data.keyword.fedora}}

We should search through the markdown files. For instance:

1. Clone the repo
2. cd open-horizon-github.io/docs
3. find . | grep .md | xargs grep Intel

I'll continue this idea.

Describe the solution you'd like.

No response

Describe alternatives you've considered

No response

Additional context.

No response

[johnwalicki]

Look at proper name and trademark examples on this page: https://open-horizon.github.io/docs/installing/adding_devices.html

[johnwalicki]

Podman and Netavark should be substitution strings

[saurav1004]

Hello @johnwalicki, Can I be assigned this issue ? I was able to reproduce it on my system locally and got an idea of what needs to be done.

I think there are two parts to this issue :

1. marking the existing keywords in the md files (if not done already)
2. looking for new keywords in the md files, updating it in the keyword.yml and making necessary changes in the md files (like in the case of podman and Netavark)

[joewxboy]

@saurav1004 You got it. "@" mention us if you have any questions.

[johnwalicki]

Ubuntu ?

[saurav1004]

Ubuntu ?

Yup I am on Ubuntu

[saurav1004]

@joewxboy @johnwalicki I have added some missing markers in the adding_devices.md file. Also, I updated the keywords.yml to include a few additional proper names. Should I submit a PR, so you can review the changes and confirm ?

Once confirmed I can make similar changes in all the remaining files of the repo.

[johnwalicki]

Ubuntu ? Yup I am on Ubuntu

That's good, but I meant that Ubuntu could be a substitution string.

Instead of a PR and pile of commits and reviews. Let's discuss the list of possible new keywords here first. Once we settle on a list, then work on a PR. That might save you a ton of frustrating rework.

[saurav1004]

Ahh I should have understood.😄 Yeah sure we can do that.

These are the ones I have found till now from looking at the docs/installing/adding_devices.md file. There could be more in other files too.

• [x] AMD
• [x] Apple
• [ ] ARM
• [x] Debian
• [x] CentOS
• [x] Jetson
• [x] Jetpack
• [x] MicroSD
• [x] NVIDIA
• [x] Raspberry
• [ ] SSH
• [ ] SSD
• [x] Ubuntu
• [ ] Wifi
• [ ] wpa2

[johnwalicki]

Good list. I would remove acronyms from the list; SSH, SSD, WiFi and WPA2

Let's ask @Rene-Ch1 to comment. She's our editor and tech writer expert.

[saurav1004]

Sure. I will keep adding new suggestions in the same comment as updates below the ones I have listed already.

[johnwalicki]

Do we need to add armhf or arm64

[saurav1004]

Do we need to add armhf or arm64

arm64 I suppose. But what I am confused about is, there are mentions of just ARM as well, they too need to be marked separately right ?

[joewxboy]

@saurav1004 Are you still working on this, or can I assign it to someone else?