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

Created 18.01 branch of the documentation.

Browse Source 
git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@1942 abb3cda0-5349-4a8f-a601-0c33ac3a8c38
This commit is contained in:
eiffel-org
2018-02-08 15:00:31 +00:00
parent 265a446dab
commit b5d5c80911
2923 changed files with 61520 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
documentation/18.01/contribute/documentation.wiki Normal file
View File

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