From b2982ac87ccfb1b915ca6d365bbcdb7b0a3a9904 Mon Sep 17 00:00:00 2001 From: jfiat Date: Mon, 9 Mar 2015 13:34:58 +0000 Subject: [PATCH] Added first contribute pages to the documentation. git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@1421 abb3cda0-5349-4a8f-a601-0c33ac3a8c38 --- .../current/contribute/documentation.wiki | 37 +++++++++++++++++++ documentation/current/contribute/index.wiki | 7 ++++ 2 files changed, 44 insertions(+) create mode 100644 documentation/current/contribute/documentation.wiki create mode 100644 documentation/current/contribute/index.wiki diff --git a/documentation/current/contribute/documentation.wiki b/documentation/current/contribute/documentation.wiki new file mode 100644 index 00000000..17a5d1a1 --- /dev/null +++ b/documentation/current/contribute/documentation.wiki @@ -0,0 +1,37 @@ +[[Property:title|How to contribute to documentation]] +[[Property:link_title|To documentation]] +[[Property:weight|1]] + += Current documentation system = +* The documentation is written using wikitext syntax. +* Each page is stored in a wiki file on disk. +* Those files comes from a subversion repository (see [https://svn.eiffel.com/eiffel-org/trunk/documentation/current]). +* The outline of book are following the underlying directory structure, and each wiki file can have properties that hold metadata such as: +:[[Property:title|The page title]] +:[[Property:link_title|short title]] +:[[Property:weight|5]] + += 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/current/] 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 = +* svn checkout https://svn.eiffel.com/eiffel-org/trunk/documentation/current/ +* 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/current/] + + diff --git a/documentation/current/contribute/index.wiki b/documentation/current/contribute/index.wiki new file mode 100644 index 00000000..2f3cb208 --- /dev/null +++ b/documentation/current/contribute/index.wiki @@ -0,0 +1,7 @@ +[[Property:title|How to contribute]] +[[Property:description|How to contribute]] +[[Property:link_title|Contribute]] +[[Property:weight|6]] + += How to contribute to Eiffel ? = +