Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

When exporting bootstrap files directly from within Magnolia (such as module configuration) do not export complete trees; export individual configuration items. This helps to ensure that multiple developers can work on the same module without creating conflicts. When importing config files directly into a live instance via the configuration app, you may need to restart the server for the changes to take effect.

Exercise

Casual

Requires a running instance of Magnolia

...

  • the file name defines the workspace and path where the xml will be bootstrapped to;
  • config is reflected in the content of the bootstrap file;
  • metadata (such as creation date, mod date, activation status etc.) is not displayed in the tree view in the config app, but is displayed in the xml file.

YAML

One of the latest features in Magnolia is 'configuration by file'. We developed this to make it easier for non-Java developers to create templates in Magnolia. Configuration by file eliminates the need to need to use an IDE. With this new functionality came a new configuration export mechanism - download YAML files. Existing app and template configuration can now be converted to YAML for ease of distribution.

We looked at this in Hello Magnolia video tutorial- No IDE and also in MTE.


Why download configuration as a YAML file and not export as an XML file?
 

  •  Download to YAML is for working in the file system rather than in the Magnolia repository - this makes it ideal for team collaboration as.  YAML based configuration is easier to diff and easier to share with other developer.
  • Exporting to XML is typically done in order to take a backup of configuration, share it with your colleagues or to bootstrap configuration. Importing config is a good 'on the fly' solution in live projects.

Exercise

Casual

Requires a running instance of Magnolia

  1. Navigate to Standard Templating Kit module in your running instance of Magnolia.
  2. Export  the configuration for templates > components > content > stkHTML
  3. Open the xml file and note that:

    • the file name defines the workspace and path where the xml will be bootstrapped to;
    • config is reflected in the content of the bootstrap file;
    • metadata (such as creation date, mod date, activation status etc.) is not displayed in the tree view in the config app, but is displayed in the xml file.

Learn more

Official Documentation

...