mirrors/eiffel-org
1
0
Fork 0
mirror of https://github.com/EiffelSoftware/eiffel-org.git synced 2025-12-06 06:42:03 +01:00
Code Issues Packages Projects Releases Wiki Activity

Added README file about the wiki based documentation, and initial migration from docs.eiffel.com.

Browse Source 
git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@1419 abb3cda0-5349-4a8f-a601-0c33ac3a8c38
This commit is contained in:
jfiat
2015-02-18 10:50:41 +00:00
parent 1d2304e331
commit 6ab46102ce
1 changed files with 17 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
documentation/README.md Normal file
View File

@@ -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.