DocFX: Update README with Deployment instructions
authorXavi Artigas <xavierartigas@yahoo.es>
Wed, 31 Jul 2019 10:53:48 +0000 (12:53 +0200)
committerWooHyun Jung <wh0705.jung@samsung.com>
Mon, 5 Aug 2019 02:05:24 +0000 (11:05 +0900)
The deployment process is currently manual so we better write it down.

doc/docfx/README

index a35110c..05925bb 100644 (file)
@@ -25,4 +25,22 @@ repository and adapt them to the DocFX syntax.
 Finally, run the `gendoc.sh` script (also from this folder) to produce the HTML
 files. First run can take a long time (from 10' to 1h), subsequent runs use
 cached results and take about 5 minutes.
+The result can be found in the _site folder.
 
+DEPLOYMENT
+----------
+
+This is the manual deployment process currently in use. It could certainly
+be improved and automated.
+The HTML files produced by DocFX are currently hosted using GitHub pages.
+The Enlightenment site's content is hosted in the www-content repository:
+https://git.enlightenment.org/website/www-content.git/
+This repo is mirrored at GitHub:
+https://github.com/Enlightenment/www-content
+The GitHub mirror has a branch called "gh-pages" which has a "gh-pages"
+folder at the root.
+
+Whenever new documentation is generated, just copy the _site folder from
+/doc/docfx in the EFL repo to /gh-pages/api/csharp in the www-content repo
+(gh-pages branch!) and push to the GitHub mirror.
+Changes should be visible almost instantly, since they are static pages.