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

Complete Documentation #3

Open
ttbek opened this issue Mar 20, 2018 · 4 comments
Open

Complete Documentation #3

ttbek opened this issue Mar 20, 2018 · 4 comments
Milestone

Comments

@ttbek
Copy link

ttbek commented Mar 20, 2018

Several areas of cloudgene.io have incomplete documentation, e.g. http://docs.cloudgene.io/daemon/administration/

I can't find anything about how to modify the webui other than that it uses some combination of javascript, java, and is built with nodejs grunt and maven. It is really very unclear to me still though.

I found this https://scotch.io/tutorials/use-ejs-to-template-your-node-application

Which suggests to me that placing .ejs files in /data/pages (based on the cloudgene.conf file) would be used to replace the defaults? That doesn't seem to work for me though. Does it need to be totally rebuilt, ala the DEVELOPING.md file?

I may just be in over my head with this framework.

@ttbek
Copy link
Author

ttbek commented Mar 20, 2018

Ah, with the right permissions it seems to work for say home.ejs, but not for say help.ejs, which I was trying when I opened the issue, it continues to link to the github page instead. I guess to make other changes I will need to modify the index.html or will I need to rebuild?
For instance, to change the line:"powered by Cloudgene and supported by the U.S. National Institutes of Health and the FWF Austrian Science Fund" to "powered by Cloudgene" as our work is not supported by the NIH or FWF Austrian Science Fund.

@lukfor
Copy link
Member

lukfor commented Mar 23, 2018

Documentation is currently work in progress. Cloudgene has some mechanisms to integrate pages (like help.ejs) without rebuilding the webapp using grunt. Unfortunately, this feature is not yet documented :( I keep you updated as soon as a tutorial is ready!

@ttbek
Copy link
Author

ttbek commented Apr 11, 2018

I figured out how to point the help page elsewhere and change the appname, they are set in the settings.yaml

Snippets:

navigation: !java.util.Vector
- !cloudgene.mapred.util.MenuItem
id: help
name: Help
link: HELP_LINK_URL_GOES_HERE

and the name that appears in the upper left of every page:

name: NAME_GOES_HERE

I suppose these will be added to this section of the documentation later: http://docs.cloudgene.io/daemon/configuration/ Though the settings.yaml doesn't seem to be exclusive to running the daemonized version.

Still not sure about removing "powered by Cloudgene and supported by the U.S. National Institutes of Health and the FWF Austrian Science Fund" to "powered by Cloudgene," I don't want it to be misconstrued that NIH or FWF are endorsing us.

@lukfor
Copy link
Member

lukfor commented Apr 12, 2018

At the moment, the footer message is stored in the database.
You can change it in the Admin Panel by clicking on Templates. There is a key FOOTER which contains the footer message.

I am working hard on updating the documentation ;)

@lukfor lukfor added this to the 1.3.5 milestone Apr 12, 2018
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

2 participants