Local HTML documentation stored in a temp directory.
I an more than a little concerned to discover that somebody considered it reasonable to store Browser based Documentation in a temporary directory.
This is a local example: file:///G:/WebServers/Jetbrains/TeamCity/temp/dslPluginsDoc7808616686802503283dir/index.html which yields Kotlin DSL API documentation.
To my best knowledge, going back to the days when 'C' was known as 'B' and Unix was in its infancy, a 'temp' directory was used only for short term storage of data that was not expected to exist any longer than the lifespan of the application that created the data. Further, in the case of a long running application, any data created in the temp directory should be removed as soon as it was no longer required. The practice enabled sys admins to conserve disk space usage and thus realising cost savings. This need has not changed in any way in this modern world of ours.
Is this an oversight?
Please sign in to leave a comment.
Hi Bruce,
It is not an oversight, it's intended and there is a good reasoning behind it. First of all, it's a documentation that is not required by some, but is very useful for others to have offline, so it's easily removed if the sysadmin considers appropriate. But the main point on the documentation about the DSL is that it can be modified depending on which plugins are available on the server, the bundled ones for now and support for third party plugins on the DSL is expected to come at some point in the future. Under this conditions, TeamCity generates its (dynamic) DSL documentation upon server start (you can find a message about it on the server logs) and as of now, we have considered the temp folder to be the most appropriate location.
I hope this clarifies it a bit. If you have any better suggestion for a place for it, our issue tracker is open for requests: https://youtrack.jetbrains.com/issues/TW