mautic / mautic/developer-documentation-new
Implement syncing Vale definitions between this repo and mautic/mautic-documentation
Nobody has claimed this yet.
- Dominant language
- Shell
- Stars
- 19
- Forks
- 48
- Avg merge
- 1d 16h
- Merged PRs (30d)
- 25
Description
Vale has been implemented in both repositories and thus have the same definition files that must be kept up to date. It would be better to keep these in sync. Maybe we can store the definitions in another repository and use git submodules (each repo would still need to pull the latest hash) or use some Github action magic.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the Vale definition files in this repository with those in mautic/mautic-documentation. Review the proposed Git submodule and GitHub Actions approaches, then define a synchronization mechanism that keeps both repositories on the same definitions and documents how updates are made.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git, github-actions
- Domain
- build-system, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100