search

openSUSE / suse-vale-styleguide

Humble style guide for technical writers by a technical writer
GNU General Public License v3.0
23 stars 5 forks source link

Create SoftwareNames.yml #93

Closed alexvonme closed 5 months ago

alexvonme commented 5 months ago

As discussed in #90, I think it might be useful to have a file where software projects within openSUSE can add their preferred form of address.

tbazant commented 5 months ago

As discussed in #90, I think it might be useful to have a file where software projects within openSUSE can add their preferred form of address.

Such file can be auto-generated from our TermWeb databse if @jfaltenbacher is interested in populating it with SUSE software names. @alexvonme do you thing that SUSE product names fall into this category as well? If yes, they're already part of TermWeb database. But Our policy is rather to use entities for fixed product/software names.

jfaltenbacher commented 5 months ago

Yes, there are already many SUSE product names available in TermWeb also some for openSUSE and Rancher, NeuVector etc. I can provide an export of those in .tbx. or .csv format.

alexvonme commented 5 months ago

@tbazant I'm still new to SUSE, so I'm not entirely informed on how SUSE approaches the TermWeb. It seemed exclusive to employees and customers, I wasn't aware we could have an export from there.

@jfaltenbacher I'm not familiar with the TermWeb, is it possible to separate product names and other terms? I think that might be a great solution, since other organizations have their own terminology and preferences (for us, TermWeb.yml), while we could ask cooperating open-source organizations to simply adopt (and possibly rename) our "SoftwareNames.yml". @tbazant this could also be a good step into reducing the needless iterations every organization repeats of the most basic spelling and term preference YAML files. Or at least incentivize reducing some inefficiency.

jfaltenbacher commented 5 months ago

For each entry in TermWeb, we also capture some metadata (for example Domain and Product family). With this it is also possible to filter for entries with certain Domain like 'Product name'. You can find more information on which metadata fields are currently available and many more around TermWeb here. I would also be available for a call to discuss more in detail, if needed.

ccoVeille commented 5 months ago

the content of the site is restricted, maybe it's normal, but as this repository is public it doesn't help :stuck_out_tongue_winking_eye:

jfaltenbacher commented 5 months ago

yes, sorry, I thought alexvonme might have access

ccoVeille commented 5 months ago

So apparently TermWeb terms were provided by #97