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

First Release #115

Open alexvonme opened 1 month ago

alexvonme commented 1 month ago

We should have a first release where the asciidoc, docbook and common folders are released as .zip files. Sharing the style guide in such a manner seems to be the suggested route for projects utilizing Vale. This would also make it easier for anyone to add openSUSE through the suggested vale sync functionality.

tbazant commented 1 month ago

@alexvonme i've created https://github.com/errata-ai/packages/pull/20 - is it the right way to start? I have no experience with vale packages

tbazant commented 1 month ago

is this sort of duplicate of https://github.com/openSUSE/suse-vale-styleguide/issues/105 ?

alexvonme commented 1 month ago

@alexvonme i've created errata-ai/packages#20 - is it the right way to start? I have no experience with vale packages

I thought we were going to do that later but I guess we're going for a quick launch. However, we need to add a common.zip folder that is our actual ruleset. You may check the Microsoft Release for reference. Instead of the full repository, we need to start sharing the folder with rules as a ZIP package.

is this sort of duplicate of #105 ?

They are related but I want to add a few things in relation to that one. These include additional testing and detailed instructions in the README.