Updated to upcoming 23.09

git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@2393 abb3cda0-5349-4a8f-a601-0c33ac3a8c38

documentation/23.09/contribute/documentation.wiki

@@ -0,0 +1,44 @@
+[[Property:title|How to contribute to documentation]]
+[[Property:link_title|To documentation]]
+[[Property:weight|2]]
+[[Property:uuid|A2DED192-B50A-4E59-B214-FDC3FEDC7A44]]
+
+= Current documentation system =
+* The documentation is written using wikitext syntax (similar to wikipedia).
+* Each documentation page is stored in a wiki file on disk.
+* Those files come from the subversion repository: [https://svn.eiffel.com/eiffel-org/trunk/documentation/trunk] .
+* The outline of book are following the underlying directory structure, and each wiki file can have properties that hold metadata such as:
+<code>
+[[Property:title|The page title]]
+[[Property:link_title|short title]]
+[[Property:weight|5]]
+</code>
+** '''link_title''' is used to have a short title in menu, or various links.
+** '''weight''' is used to order sibling pages (lower weight goes before, upper weight goes after).
+
+= To contribute =
+* First, you can post comment on any page (see comment form at the bottom of each page).
+* As one would contribute to any source maintained on a subversion repository, one can contribute via the repository [https://svn.eiffel.com/eiffel-org/trunk/documentation/trunk/] and provide patch.
+* Note there is also a git mirror at [https://github.com/eiffelsoftware/eiffel-org] so you can also contribute via github by sending pull request.
+
+= Step by step with git =
+* Go to [https://github.com/eiffelsoftware/eiffel-org] for the project, then git clone on your machine.
+* create a git branch.
+* add or edit the files locally.
+* once you want to share your changes.
+** git commit your changes.
+** git push them to your github repository.
+** then create a pull request so that the Eiffel.org documentation team can review and integrate the changes.
+* See current pull requests at [https://github.com/EiffelSoftware/eiffel-org/pulls].
+
+= Step by step with subversion =
+* <code>svn checkout https://svn.eiffel.com/eiffel-org/trunk/documentation/trunk/</code>.
+* add or edit the files locally.
+* once you want to share your changes.
+** svn update.
+** Send the patch via [https://codereview.appspot.com/]. (note: follow the instructions from codereview site, you will need to use a python script "upload.py" distributed by the codereview site).
+* See current patches at [https://codereview.appspot.com/search?base=https://svn.eiffel.com/eiffel-org/trunk/documentation/trunk/].
+
+= Live editing on this site =
+* If you are a trusted editor, you can edit the documentation directly.
+* To be a trusted editor, please request it via the [https://www.eiffel.org/contact contact] page (do not forget to mention who you are and why you think you should be a trusted editor).

documentation/23.09/contribute/editing_help.wiki

@@ -0,0 +1,134 @@
+[[Property:modification_date|Tue, 24 Jan 2023 15:52:04 GMT]]
+[[Property:publication_date|Tue, 24 Jan 2023 15:52:04 GMT]]
+[[Property:uuid|21D430EE-C9E0-46CC-8310-98521B77CA01]]
+[[Property:title|Help to edit documentation]]
+[[Property:link_title|Editing help]]
+[[Property:weight|3]]
+
+= Wikitext syntax =
+* Have a look at [https://en.wikipedia.org/wiki/Help:Wiki_markup Wikipedia markup] documentation.
+* The current website does not support the full Wikipedia syntax, but still most of the needed cases.
+
+* To add a link to another wiki page
+** `[[Wiki Page Title]]` or `[[Wiki Page Title|Custom text]]` (to use a specific text for the link)
+** for instance, a link to this current page would be `[[Help to edit documentation]]` : [[Help to edit documentation]]
+
+* To add a link to any URL
+** `[https://www.eiffel.com Eiffel.com]` (bracket, url, space text, bracket) 
+** Result: [https://www.eiffel.com Eiffel.com]
+
+* To embed inline code:
+** `` `foo.bar` ``
+** `<code>foo.bar</code>`
+** `<eiffel>foo.bar</eiffel>`
+
+* To embed block code:
+
+```xml
+<code lang="eiffel">
+	class FOOBAR
+</code>
+```
+
+```xml
+<eiffel>
+	class FOOBAR
+</eiffel>
+```
+
+<code lang="text">
+```eiffel
+	class FOOBAR
+```
+</code>
+
+Note: if you do not specify the lang, it is defaulted to "eiffel"
+
+
+
+= Templates =
+== Top page templates ==
+Used to qualify the current page.
+
+=== ReviewRequested ===
+:<nowiki>{{ReviewRequested|This is a ReviewRequested message}}</nowiki>
+{{ReviewRequested|This is a ReviewRequested message}}
+
+=== UnderConstruction ===
+:<nowiki>{{UnderConstruction|This is a UnderConstruction message}}</nowiki>
+{{UnderConstruction|This is a UnderConstruction message}}
+
+=== UpdateNeeded ===
+:<nowiki>{{UpdateNeeded|This is a UpdateNeeded message}}</nowiki>
+{{UpdateNeeded|This is a UpdateNeeded message}}
+
+=== Beta ===
+:<nowiki>{{Beta|This is a beta message}}</nowiki>
+{{Beta|This is a beta message}}
+
+
+== Block templates ==
+=== Caution ===
+:<nowiki>{{Caution|This is a caution message}}</nowiki>
+{{Caution|This is a caution message}}
+
+=== Definition ===
+:<nowiki>{{Definition|abc|This is a Definition message}}</nowiki>
+{{Definition|abc|This is a Definition message}}
+
+=== Info ===
+:<nowiki>{{Info|This is a Info message}}</nowiki>
+{{Info|This is a Info message}}
+
+
+=== Note ===
+:<nowiki>{{Note|This is a Note message}}</nowiki>
+{{Note|This is a Note message}}
+
+=== Recommended ===
+:<nowiki>{{Recommended|This is a Recommended message}}</nowiki>
+{{Recommended|This is a Recommended message}}
+
+=== Rule ===
+:<nowiki>{{Rule|name=abc|text=This is a Rule message}}</nowiki>
+{{Rule|name=abc|text=This is a Rule message}}
+
+=== Sample ===
+:<nowiki>{{Sample|This is a Sample message}}</nowiki>
+{{Sample|This is a Sample message}}
+
+=== SeeAlso ===
+:<nowiki>{{SeeAlso|This is a SeeAlso message}}</nowiki>
+{{SeeAlso|This is a SeeAlso message}}
+
+=== Tip ===
+:<nowiki>{{Tip|This is a Tip message}}</nowiki>
+{{Tip|This is a Tip message}}
+
+=== Warning ===
+:<nowiki>{{Warning|This is a Warning message}}</nowiki>
+{{Warning|This is a Warning message}}
+
+
+== Inline templates ==
+
+=== Key ===
+:<nowiki>This is a {{Key|key message}} in the text. </nowiki>
+This is a {{Key|key message}} in the text.
+
+=== Error ===
+:<nowiki>This is a {{Inline-Error|error message}} in the text. </nowiki>
+This is a {{Inline-Error|error message}} in the text.
+
+=== Info ===
+:<nowiki>This is a {{Inline-Info|info message}} in the text. </nowiki>
+This is a {{Inline-Info|info message}} in the text.
+
+=== Success ===
+:<nowiki>This is a {{Inline-Success|success message}} in the text. </nowiki>
+This is a {{Inline-Success|success message}} in the text.
+
+=== Warning ===
+:<nowiki>This is a {{Inline-Warning|warning message}} in the text. </nowiki>
+This is a {{Inline-Warning|warning message}} in the text.
+

documentation/23.09/contribute/index.wiki

@@ -0,0 +1,10 @@
+[[Property:title|How to contribute]]
+[[Property:description|How to contribute]]
+[[Property:link_title|Contribute]]
+[[Property:weight|6]]
+[[Property:uuid|56480505-4CD5-4C8A-AA3D-120FD573DFA9]]
+
+= How to contribute to Eiffel ? =
+
+Check page [https://www.eiffel.org/contribute] .
+