fix(globalConfig): update name and rest root convention

hetangmodi-crest commented 3 weeks ago

Issue number: ADDON-74883, #1333

Summary

Changes

Changed the validations for name and restRoot field according to the conventions specified in ADDON-74883. Additionally, the add-on will not be built if the name in globalConfig does not match the name in app.manifest.

User experience

User has to keep the same add-on name in globalConfig and app.manifest, if the name does not match then add-on will not be built. This is usually never the case unless the `app.manifest or name in globalConfig is changed manually after initializing the add-on.

Checklist

If your change doesn't seem to apply, please leave them unchecked.

[x] I have performed a self-review of this change
[x] Changes have been tested
[x] Changes are documented
[x] PR title follows conventional commit semantics

hetangmodi-crest commented 2 weeks ago

While generating documentation for the above feature, I encountered two major issues that affected our documentation:

1) Markdown lint has a default indentation of 2 spaces for unordered lists (source). However, according to MkDocs, the syntax rules specify that when a list item contains multiple paragraphs, each subsequent paragraph in a list item must be indented by either 4 spaces or one tab (source).

2) Markdown lint incorrectly raises an error for ul-style, even though we followed the convention outlined in the Markdown lint docs.

With the fix in indentation and unordered list bullets, the doc pages are rendered correctly - with correct indentation, giving better readability.

artemrys commented 2 weeks ago

LGTM, 2 small questions and ready to merge this one!

hetangmodi-crest commented 1 week ago

Signed the commits which got unsigned due to expired GPG Key.

artemrys commented 6 days ago

@hetangmodi-crest this PR removes files in the testdata folder, is that intended?

hetangmodi-crest commented 1 day ago

Yes, I have raised PR #1349 for the same.

splunk / addonfactory-ucc-generator