tinymce
DOC-2347 Automation script for generating new plugin docs
Ticket: DOC-2347
Changes:
- Add script for generating new plugin docs
- Clean-up of templates files
Pre-checks:
- [x] Branch prefixed with
feature/7/orhotfix/7/ - [x] Files has been included where required
(if applicable)
Review:
- [ ] Documentation Team Lead has reviewed
@TheSpyder good point, I had not considered windows compatibility when writing this script.
While looking into this, I discovered that tinymce-docs default branch is not even compatible with windows because some template files in the -new-material-templatesdirectory use < and > in the name which results in errors when git cloning the repo on windows. I was able to get around this by replacing < and > with _ and that fixed the git cloning issue. A temporary workaround for windows is to run the script using git bash with only some minor tweaks to the script.
Do you have any suggestions for how you would approach solving this problem?
@FarzadHayat sorry, I don't always see @ pings as I get about 100 github emails a week and tend to rely on review requests.
Apparently I wasn't paying attention to the filenames when I reviewed #2801!
For windows, I don't mind saying WSL is required (we do that on some of our other repositories). But that only solves the bash issue, not the filename issue.
When I said This isn't how I would solve the problem, what I meant was not having template files in the repo and copying them with scripts. I'd look at yeoman or another similar tool that is designed to take a template structure and fill in the gaps to generate a series of files.
Focus on the template content, which is the real concern here, not the act of using templates for which there are many options available and isn't our core competency.
Marked as draft to stop it notifying the team until the questions are sorted out