Add docs spellcheck via GitHub Actions

[SeanKilleen]

IMPORTANT

• The code complies with the Coding Guidelines for C#.
• The changes are covered by unit tests which follow the Arrange-Act-Assert syntax and the naming conventions such as is used in these tests.
• If the PR adds a feature or fixes a bug, please update the release notes with a functional description that explains what the change means to consumers of this library, which are published on the website.
• If the PR changes the public API the changes needs to be included by running AcceptApiChanges.ps1 or AcceptApiChanges.sh.
• If the PR affects the documentation, please include your changes in this pull request so the documentation will appear on the website.

[SeanKilleen]

cSpell has 39 findings in 16 files. Should be a quick cleanup.

[SeanKilleen]

@dennisdoomen FYI :) I think this is ready for review/merge at your leisure. I'll do a self-review now to leave comments.

[dennisdoomen]

Thanks for the contribution. I would prefer to have the build steps encoded in the Nuke build script and rely as little as possible on the YAML madness. Would that something you would be willing to pick up?

[SeanKilleen]

@dennisdoomen sorry but I really don't have space for that. Not familiar with Nuke and really only have the space to reproduce my templated changes. GitHub actions makes it pretty easy and I don't find YAML to be particularly hard at all. Let me know if I can explain any of the YAML.

If Nuke can install node, and install cSpell, and run the cSpell cli, then this PR should provide a template for what packages to install and what to tell Nuke to do. 👍 Feel free to close if it's not what you're looking for, no offense will be taken. 😄

[jnyrup]

Nuke has NpmTasks, so it might be doable.
(Not specifically asking you to do the work).

[dennisdoomen]

sorry but I really don't have space for that

No worries. I will take care of that when I have space myself ;-)

[IT-VBFK]

Hi :)

is this PR stale?

Because if you don't mind (@dennisdoomen, @SeanKilleen) I can give this a try to convert to NUKE.

[jnyrup]

@IT-VBFK You're very welcome to give it try ❤️

[IT-VBFK]

Cool

Just a few questions:

• Is it the goal to completely avoid yml? Because the step "install Node.js" might be doable via NUKE, but I think we should also avoid "reinventing the wheel"
• Now the cSpell config ignores the release notes. If I omit this ignore path, cSpell complains about mainly contributor names like "jnyrup" :). Should we just ignore the specific words, or leave the complete file untouched?

[dennisdoomen]

• Is it the goal to completely avoid yml? Because the step "install Node.js" might be doable via NUKE, but I think we should also avoid "reinventing the wheel"

No, but ideally, our build script runs locally just like it runs on the server. There's no .NET package to install Node and NPM, but in my projects, we got pretty close using Yarn:

#if WINDOWS
    [PackageExecutable("Node.js.redist", "node.exe", Version = "16.17.1", Framework = "win-x64")]
    Tool Node;
#else
    [PackageExecutable("Node.js.redist", "node", Version = "16.17.1", Framework = "linux-x64")]
    Tool Node;
#endif

    string YarnCli => ToolPathResolver.GetPackageExecutable("Yarn.MSBuild", "yarn.js", "1.22.19");

    Node($"{YarnCli} run clean", workingDirectory: WebDirectory, customLogger: LogErrorAsWarning);

    static void LogErrorAsWarning(OutputType outputType, string message)
    {
        if (outputType == OutputType.Err)
        {
            Warning(message);
        }
        else
        {
            Information(message);
        }
    }

[IT-VBFK]

Ok, but this requires to have node installed. Is it arguable to force contributors to install node on their dev devices only to run NUKE? Or just skip the Spellcheck target?

Edit: What's my advantage here? Because of node.js have to be installed, I have to use the github action "Setup NodeJS" which also installs NPM.

[dennisdoomen]

What's my advantage here? Because of node.js have to be installed, I have to use the github action "Setup NodeJS" which also installs NPM.

It will unpack a specific version of Node in a portable fashion so that nobody has to have the right version of Node installed locally or on the build server.

[IT-VBFK]

Thanks for you help :) I think I have a reasonable state now :)

[SeanKilleen]

Given that this is transitioning to #2086, going to close this one. 👍 Glad to see @IT-VBFK taking things forward!

[IT-VBFK]

Glad to see @IT-VBFK taking things forward!

No problem :)