outsystems/docs-validation

Validation rules for OutSystems documentation in Markdown files.

OutSystems Documentation Validation Rules

Contains a set of rules used to validate OutSystems documentation.

Each release (OutSystems.zip file) contains a set of rules defining the OutSystems style for vale.

Creating a new release

1. Clone this repository by entering the following command in a command prompt:

    git clone https://github.com/OutSystems/docs-validation.git
   

2. Install Node.js version 10 or greater.

3. Create a GitHub access token if you don't have one.

4. Define an environment variable named GITHUB_TOKEN with your GitHub access token as a value.

5. In a command prompt, change to the folder of the cloned repository, for example to the docs-validation folder.

6. If you're running Linux, edit the .release-it.yml file and change the after:bump hook line according to the file comment.

7. Run the following command in the command prompt:

    npx release-it
   

   npx is bundled with Node.js and allows you to run commands from NPM packages without having to install those packages locally. It also makes sure that you always run the command available in the latest package version.

8. Answer some questions asked by the release-it command according to the type of release you're doing (fix, minor release, major release).

Publishing the draft release

The command creates a draft release in GitHub and you must publish it to make it public.

Do the following:

1. Open the Releases page for the docs-validation repository in GitHub.

2. Review the automatically generated changelog, editing it if necessary.

3. Zip contents of styles-vale/OutSystems into OutSystems.zip. Attach OutSystems.zip as binary file to release.

4. Publish the release to make it public.