align makefile with other projects

projectsyn / documentation

The Project Syn main documentation repository

https://docs.syn.tools/

BSD 3-Clause "New" or "Revised" License

6 stars 3 forks source link

align makefile with other projects #135

Closed tobru closed 3 years ago

tobru commented 3 years ago

This PR aligns the Makefile with other projects we're using. It mainly makes sure that make preview is available to have the local preview up and running, instead of make docs-serve, like in any other Antora documentation project we're having.

Checklist

[x] Keep pull requests small so they can be easily reviewed.
[x] Update the documentation.

ccremer commented 3 years ago

I'm not sure which projects you are referring to, but for the components it's more of a disalignment now :D (the components use make docs-serve, also in modulesync template f.e.)

tobru commented 3 years ago

Oh noes... Then, let's forget about it

ccremer commented 3 years ago

not so hasty :) I'm not opposed to the change. in fact it seems to improve certain areas and we could consider it making into the modulesync and component template so that at least new and m-managed components benefit from new spellers etc.

tobru commented 3 years ago

I didn't mean to invest too much time, and I'm unsure if it's feasible for other non-docs-only related projects. As I'm currently mostly working with docs-only repos (aka Makefiles), the most common command I'm using is make preview, which on this project would be make docs-serve. Having make preview on a project where documentation isn't the primary intent might not make sense.