(GH-702) added documentation for TeamCity

[nils-a]

Seems exposing vcsroot.branch is required for Cake.Recipe to run.

fixes #702

[gep13]

@nils-a thanks for this, really appreciate it!

Does this configuration go into a file in the repository, or does this go into a build configuration within TeamCity? Historically, TeamCity was very much UI driven. How would I take have you have provided here and get it into a build?

[nils-a]

@gep13 no, that's the DSL, as displayed in TeamCity - as far as I see the DSL can be edited in the UI but not checked into the repository like the others. (Probably should mention that, though.)

[pascalberger]

TeamCity can store its configration in a VCS, see https://www.jetbrains.com/help/teamcity/storing-project-settings-in-version-control.html. But I would suggest to keep it to the user how he uses TeamCity (through UI, with settings stored in XML, with settings stored in Kotlin)

[nils-a]

@gep13 @pascalberger I have added a sentence to explain the exported Kotlin DSL.

Should we better use screenshots to document this?

[gep13]

@nils-a screenshots never hurt, so if you wanted to add some here, I certainly wouldn't say no 😄

[nils-a]

@gep13 added a textual guideline thru the TeamCity-UI, including two screenshots. (and I was able to add the img-responsive-class thanks the video from the week before 😃 )

[gep13]

LGTM!

[gep13]

@nils-a thanks for getting this documented!