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

Updated how to contribute to documentation.

Browse Source 
git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@1427 abb3cda0-5349-4a8f-a601-0c33ac3a8c38
This commit is contained in:
eiffel-org
2015-08-05 08:53:27 +00:00
parent ad573a86a3
commit 8901c4aca4
1 changed files with 39 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

77
documentation/current/contribute/documentation.wiki
View File

@@ -1,38 +1,39 @@
[[Property:title|How to contribute to documentation]]
[[Property:link_title|To documentation]]
[[Property:weight|1]]
[[Property:uuid|aab3d23e-ef56-4324-b885-067b14a3009b]]
= 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:
:<nowiki>[[Property:title|The page title]]</nowiki>
:<nowiki>[[Property:link_title|short title]]</nowiki>
:<nowiki>[[Property:weight|5]]</nowiki>
= 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 =
* <code>svn checkout https://svn.eiffel.com/eiffel-org/trunk/documentation/current/</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/current/]
[[Property:title|How to contribute to documentation]]
[[Property:link_title|To documentation]]
[[Property:weight|1]]
[[Property:uuid|aab3d23e-ef56-4324-b885-067b14a3009b]]
= 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:
:<nowiki>[[Property:title|The page title]]</nowiki>
:<nowiki>[[Property:link_title|short title]]</nowiki>
:<nowiki>[[Property:weight|5]]</nowiki>
= 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 =
* <code>svn checkout https://svn.eiffel.com/eiffel-org/trunk/documentation/current/</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/current/].
= Live editing on this site =
* This is coming soon for trusted editors.