From 684fe6ea75f33e0da7b9b21061854391ec11091d Mon Sep 17 00:00:00 2001 From: Ewelina Wilkosz Date: Fri, 5 Oct 2018 09:09:34 +0200 Subject: [PATCH] add waraning about export to docs --- docs/migrate.md | 4 +--- docs/usageScenarios.md | 2 +- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/migrate.md b/docs/migrate.md index cf28e672..b8da2a28 100644 --- a/docs/migrate.md +++ b/docs/migrate.md @@ -16,6 +16,4 @@ Various samples of plugins' configuration can be found in [demos](../demos) fold ## Export existing configuration -To be able to do that you need to install the plugin manually on your working Jenkins instance and use export function under http://[your_jenkins_url]/configuration-as-code/. Please note that, at this time, the produced yaml output might not be usable as-is -as input for Configuration-as-Code. A strict roundtrip between export and configure is under consideration but might require some -changes in jenkins-core and few plugins. +To be able to do that you need to install the plugin manually on your working Jenkins instance and use export function under http://[your_jenkins_url]/configuration-as-code/. Please note that export is not intended to offer a directly usable jenkins.yaml configuration. It can be used for inspiration writting your own, but be aware that export can be partial, or fail for some components. \ No newline at end of file diff --git a/docs/usageScenarios.md b/docs/usageScenarios.md index aea08aff..dd3dfb00 100644 --- a/docs/usageScenarios.md +++ b/docs/usageScenarios.md @@ -30,7 +30,7 @@ The devops team would like more traceability around changes, by completely move From that point on they all have full traceability of all the changes made, and they are able to roll it back easily by reverting commits. They can review the changes simply by looking at the git diffs on commits. -**Getting there and adopting Jenkins Configuration as Code** is also quite easy for the devops team. They will need to install the plug-in, and go the the Configuration as Code menu in Manage Jenkins, and use the export function to create the initial YAML files that represent their current global configuration and plug-in's installed. +**Getting there and adopting Jenkins Configuration as Code** is also quite easy for the devops team. They will need to install the plug-in, and go the the Configuration as Code menu in Manage Jenkins, and use the export function to create the initial YAML files that represent their current global configuration and plug-in's installed. Export is not intended to offer a directly usable jenkins.yaml configuration. It can be used for inspiration writting your own, but be aware that export can be partial, or fail for some components. When the files are in git, they can point to the file in the repository in the Configuration as Code menu, and click reload so Jenkins updates it's configuration accordingly.