From 6ab46102ce19d33654c3a11a450d7c357ca57bf3 Mon Sep 17 00:00:00 2001 From: jfiat Date: Wed, 18 Feb 2015 10:50:41 +0000 Subject: [PATCH] Added README file about the wiki based documentation, and initial migration from docs.eiffel.com. git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@1419 abb3cda0-5349-4a8f-a601-0c33ac3a8c38 --- documentation/README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 documentation/README.md diff --git a/documentation/README.md b/documentation/README.md new file mode 100644 index 00000000..4e3c9987 --- /dev/null +++ b/documentation/README.md @@ -0,0 +1,17 @@ +# Overview +- The documentation is written using wikitext syntax (mediawiki syntax). +- The structure of the folders is used to represent the books outline structure. Each folder can have a content using index.wiki file. +- Each wiki file can include optional wiki properties to set metadata, for instance: + [[Property:title|The Title]] + [[Property:description|A description]] + [[Property:weight|10]] + [[Property:uuid|68b37685-64e9-f564-9258-29e709a55f44]] +- The weight is used to order pages in parent. +- The uuid is used to provide a unique identifier for page. +- Templates and images are provided for all book, or for each book inside folders _templates and _images. + +# History +- The initial files were imported from https://docs.eiffel.com/, and reinserted as subversion history (keeping date, author, log). +- The migration was done mid December, 2014 (2014-December), and latest change migrated was from 2015-Dec-05. +- Any further changes made on docs.eiffel.com will be migrated manually, if any. +- The history can be retrieved using subversion tools since this documentation is versioned at https://svn.eiffel.com/eiffel-org/trunk/documentation.