summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2019-07-31 12:53:48 +0200
committerXavi Artigas <xavierartigas@yahoo.es>2019-07-31 12:53:48 +0200
commit6a1b0c3b2f81b8f2281f09668adcf55ed9a0db8f (patch)
tree7ae08e2240f9b2dd1bb0831281f23c1c4a858a97 /doc
parent359a118cdaa9d044a2381a829c9bcae1be177b6c (diff)
downloadefl-6a1b0c3b2f81b8f2281f09668adcf55ed9a0db8f.tar.gz
DocFX: Update README with Deployment instructions
The deployment process is currently manual so we better write it down.
Diffstat (limited to 'doc')
-rw-r--r--doc/docfx/README18
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/docfx/README b/doc/docfx/README
index a35110cccf..05925bb462 100644
--- a/doc/docfx/README
+++ b/doc/docfx/README
@@ -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.