doc icon indicating copy to clipboard operation
doc copied to clipboard

Build documentation takes very long time

Open josegar74 opened this issue 6 years ago • 5 comments

This seem related to the transifex translations, doing a mvn clean install takes more than 5 minutes.

This is really slow, but maybe should be done in other way? If the build process is still valid, this should be improved I think.

I'm doing a change in 3.4.x and seem used the english rst files, not very clear if should be changed that files or in transifex.

josegar74 avatar Apr 02 '18 12:04 josegar74

The rst files are downloaded automatically from transifex and then documentation is built. If you have a slow connection that may take some time, but also it gets cached on your local, so it will be faster the next time.

As said on the README.md, if you want to force a download a get all the latest files you should use the mvn clean install -Dlatest profile to make sure latest transifex files are downloaded. Transifex should be smart and download only the updates.

Those rst files shouldn't be in the repository. If they are there, that's a mistake, they should be downloaded from Transifex. Unless you want to do the cache on github.

Delawen avatar Apr 03 '18 06:04 Delawen

The cache doesn't seem to do too much. When I execute mvn clean install it seems building several times, I guess for each language? Would be good if that's the case, to be able to configure the languages and maybe by default only build english.

Those rst files shouldn't be in the repository: they are already there https://github.com/geonetwork/doc/tree/develop/source and I don't think is clear how to manage the documentation now. I did yesterday a PR updating the documentation: https://github.com/geonetwork/doc/pull/28, but there're still some pending pull requests.

Can you point to some documentation about how should be handled the documentation?

josegar74 avatar Apr 03 '18 06:04 josegar74

Yes, it builds all the languages. If you want to build only one language, the easiest way right now is to edit this line: https://github.com/geonetwork/doc/blob/develop/Makefile#L60

Yes, maybe we should add that as parameter too.

Delawen avatar Apr 03 '18 07:04 Delawen

The documentation about the documentation is in: https://github.com/geonetwork/doc/blob/develop/README.md

What I did is just add the multilingual part, the rest is the same as it was before.

Delawen avatar Apr 03 '18 08:04 Delawen

@josegar74 is this still a problem with the updated build process? Building a single language seems pretty quick now, but building all languages still takes about 5 minutes

archaeogeek avatar Apr 25 '23 13:04 archaeogeek