Make your existing component ready for ModuleSync

  • Create .sync.yml with the following content:

    :global:
      componentName: my-component (1)
    
    docs/antora.yml:
      name: my-component (1)
      title: My Component (2)
    1 The component name
    2 A more human friendly component name
  • Ensure the rules from the previous section are followed

  • Check the component template and the ModuleSync template for further things of interest.

You can locally test the impact of ModuleSync on an existing component. You need git and docker to do so. Also you need a working SSH agent that can be made accessible within a docker container. For more details have a look at the Makefile.

  • Clone modulesync-control

  • Add your component to managed_modules.yml (no need to commit/push)

  • Run make sync:noop

  • Check the results in `modules/<namespace>/<component name>'