Skip to content

Commit 85f2d87

Browse files
committed
Add an help page for updating files managed with modulesync
1 parent 1165524 commit 85f2d87

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
layout: post
3+
title: Updating Files Managed With ModuleSync
4+
date: 2021-06-30
5+
summary: How to proceed to update files managed by ModuleSync in Vox Pupuli templates.
6+
---
7+
8+
## What is ModuleSync?
9+
10+
[ModuleSync] is used at Vox Pupuli to syncronise common files across the various modules we manage. It helps us to update all our modules a consistent way.
11+
12+
## How do I update a file managed by ModuleSync?
13+
14+
The configuration shared between our modules is setup in the [modulesync_config] repository.
15+
16+
At the root of this repository, is a directory named `moduleroot` which contains all the templates used to generate the files ModuleSync manages. Fill-in a PR against the [modulesync_config] repository to make changes to files managed by ModuleSync.
17+
18+
If your changes do not apply to *all* modules managed by Vox Pupuli, use `@config['your_custom_key']` to tune the templates expansion. The default value of `your_custom_key` can be set in ` config_defaults.yml` in the [modulesync_config] repository, and the custom value for a specific module in a `.sync.yml` file at the root of that module repository.
19+
20+
[ModuleSync]: https://github.com/voxpupuli/modulesync
21+
[modulesync_config]: https://github.com/voxpupuli/modulesync_config

0 commit comments

Comments
 (0)