Add generated file warning headers to velocity templates

[gnodet]

Add comment headers to velocity templates to indicate that the generated files should not be modified directly. The headers include information about the source template and instructions to modify the template instead of the generated file.

[elharo]

OK as a temporary stopgap, but in general generated files shouldn't even be in the source repo.

[slachiewicz]

OK as a temporary stopgap, but in general generated files shouldn't even be in the source repo.

but this is template that will be used to generate files - and expectation is that generated files will have this comment included.

[cstamas]

OK as a temporary stopgap, but in general generated files shouldn't even be in the source repo.

This is a limitation of site/doxia: it cannot process generated resources, at least not in this way. Personally, I'd get rid of this, but cannot do due Doxia/Site stuff.

[michael-o]

OK as a temporary stopgap, but in general generated files shouldn't even be in the source repo.

This is a limitation of site/doxia: it cannot process generated resources, at least not in this way. Personally, I'd get rid of this, but cannot do due Doxia/Site stuff.

Not correct, it can as long as it is a supported format: https://maven.apache.org/plugins/maven-site-plugin/site-mojo.html#generatedSiteDirectory

[cstamas]

Is markdown supported? And can i enlist the generated file in site.xml as a side menu entry?

[michael-o]

Is markdown supported? And can i enlist the generated file in site.xml as a side menu entry?

Yes, that that is no problem. The structure is identical to src/site.

[cstamas]

Yes, that that is no problem. The structure is identical to src/site.

Cool! Resolver and Maven would gladly accept a PR that is fixing this 😄