Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Build documentation takes very long time #27

Open
josegar74 opened this issue Apr 2, 2018 · 5 comments
Open

Build documentation takes very long time #27

josegar74 opened this issue Apr 2, 2018 · 5 comments

Comments

@josegar74
Copy link
Member

josegar74 commented Apr 2, 2018

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.

@Delawen
Copy link
Contributor

Delawen commented Apr 3, 2018

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.

@josegar74
Copy link
Member Author

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: #28, but there're still some pending pull requests.

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

@Delawen
Copy link
Contributor

Delawen commented Apr 3, 2018

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
Copy link
Contributor

Delawen commented Apr 3, 2018

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 Delawen removed their assignment Aug 2, 2019
@archaeogeek
Copy link
Contributor

@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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants