HTML Documentation Hosting

[eaquigley]

---

Author Name: Elizabeth Quigley (@eaquigley)
Original Redmine Issue: 3528, https://redmine.hmdc.harvard.edu/issues/3528
Original Date: 2014-02-03
Original Assignee: Elda Sotiri

---

Need to make HTML version of user guides and host it somewhere for usability testing.

---

Related issue(s): #58
Redmine related issue(s): 3465

---

[eaquigley]

---

Original Redmine Comment
Author Name: Leonid Andreev (@landreev)
Original Date: 2014-02-13T17:39:09Z

---

Documentation build has been added to the regular jenkins build; every time we run a build and re-deploy on dvn-build, the documentation will be updated there as well.
The guides url on dvn-build is

http://dvn-build.hmdc.harvard.edu/guides/index.html

Also, the makefile in the doc source tree has been updated to allow developers to build and deploy the documentation on their local systems.
This is the instruction I posted on the list:

You can build and deploy the app documentation by going to the sphinx source directory:

cd /dataverse_temp/doc/Sphinx

and running

make DOCROOT= htmldeploy

where APP DIRECTORY is where you deploy the app; for example,

/Applications/NetBeans/glassfish-4.0/glassfish/domains/domain1/applications/dataverse-4.0

Once installed, the documentation can be accessed at

http://localhost:/guides/index.html

by default, the makefile will try to use /usr/local/glassfish4 as the glassfish directory; so you can creat a symlink from there to your glassfish installation - for ex.,

ln -s /Applications/NetBeans/glassfish-4.0/glassfish/domains/domain1/applications/dataverse-4.0 /usr/local/glassfish4
(as root)

• and then you can just do

make htmldeploy

Please don't edit the makefile and change the DOCROOT to point to your install directory - then it would end up getting checked in under github and mess it up for others.

[eaquigley]

---

Original Redmine Comment
Author Name: Leonid Andreev (@landreev)
Original Date: 2014-02-13T17:44:45Z

---

P.S. updated #3465, Mike's ticket "Add link to User guides to Template", to let him know where the link should be pointing.

[eaquigley]

---

Original Redmine Comment
Author Name: Leonid Andreev (@landreev)
Original Date: 2014-02-14T20:11:11Z

---

An unfortunate update:

For individual developers' builds everything should work as described above;

For the jenkins build, that automatically deploys on dvn-build:

The documentation is NOT getting redeployed automatically; in fact, every new
build erases the previously deployed docs. So you have to restore them
manually every time - until I find a way it can be done automatically.
For now, after each jenkins build you have to go on build and do this:

sudo -i
cd /usr/local/glassfish4/glassfish/domains/domain1/applications/dataverse-4.0/
mkdir guides
cd guides
tar xvzf /tmp/guides.tgz

(i.e., jenkins builds the latest docs, and copies them into /tmp/ on dvn-build... it just can't put
them in the right place - so that has to be done manually)

[eaquigley]

---

Original Redmine Comment
Author Name: Elda Sotiri (@esotiri)
Original Date: 2014-02-27T16:51:12Z

---

working on build