Difference between revisions of "MoodleDocs:Guidelines for contributors"

Jump to: navigation, search
m (Introduction)
 
(105 intermediate revisions by 35 users not shown)
Line 1: Line 1:
You are welcome to contribute to MoodleDocs :-) Find something that can be improved, either in content, grammar or formatting, and fix it.
+
{{Help}}You are welcome to contribute to Moodle Docs. Find something that can be improved, either in content, grammar or formatting, and fix it! Note: You will need to [[Special:Userlogin|login]] to edit pages.
  
== Contributing to MoodleDocs ==
+
==Introduction==
  
* Although it is possible to edit the documentation as an anonymous user, please [[Special:Userlogin|create an account or login]].
+
* Please note that all contributions are released here under [[License|GNU General Public License]].
* Please note that all contributions are released here under [http://www.gnu.org/copyleft/fdl.html GNU Free Documentation License 1.2].
+
* Every page in Moodle has a link to a corresponding page in Moodle Docs. You can see this on [http://moodle.org moodle.org] and, from an administrator's perspective, on the [https://sandbox.moodledemo.net/ Moodle demo site].
 +
* You are encouraged to illustrate documentation with screenshots. Please refer to the [[MoodleDocs:Style guide|style guide]] for further information.
 +
* See [[MoodleDocs:Templates]] for ways of asking for editing help from other contributors.
  
== Documentation for every page ==
+
==Creating new pages==
  
* Moodle 1.6 will have a button in the header that links to pages in the wiki with the same path as the pages in Moodle. For example, the documentation page &quot;Viewing and grading submissions&quot; explains what can be seen on the page in Moodle where the teacher can view and grade assignment submissions. The URL of that page is something like <code>yourmoodlesite.org/mod/assignment/submissions.php</code>. When contributing to the documentation, if it contains part of a URL, say <code>mod/assignment/submissions</code>, it means that this documentation page refers to that page.
+
* You are welcome to create pages for additional documentation about Moodle. Simply type the name of your new page between double brackets <code><nowiki>[[New page name]]</nowiki></code> on an existing page and follow the link to start editing the new page. Alternatively, you may type in your browser address bar: <code><nowiki>https://docs.moodle.org/en/New_page_name</nowiki></code> (i.e. replace spaces in the new page name with underscores).
* Please note that the [http://moodle.org/help.php?file=index.html Moodle help files] will remain in each language pack and so their text need not be included in this documentation.
+
** Please choose a short name and capitalize the first word only (with a few exceptions, such as the word ''Moodle'').
 +
** Please follow the [[MoodleDocs:Style guide|style guide]]. If you categorize new pages it can make it easier for users to find, but the important thing is to put good content into the page.  
 +
** Page titles may be changed in the future by redirecting/moving pages, as part of documentation restructuring.
  
== Additional documentation ==
+
==Page versioning==
 +
* The English (and German) Moodle Docs have different pages for different Moodle branches from 1.9 onwards (eg, 1.9, 2.0, 2.1 .. 3.3). Other languages may have only one, two or three Moodle Docs versions (eg, 1.9, 2.x, 3.x) for each page.
 +
* It is customary to create/update/correct the current Moodle version page and the previous one (eg, 3.3 and 3.2).
 +
** Older version pages may not be available for editing. If you really need to edit one old (protected) page, leave a message in the page comments for the current version.
 +
* If the page is versioned in-line with Moodle releases, MoodleHQ will create the new page as the new release approaches, by cloning the documentation for the previous release.
 +
** Example of a versioned page:
 +
*** Moodle 3.2: https://docs.moodle.org/32/en/LDAP_authentication
 +
*** Moodle 3.3: https://docs.moodle.org/37/en/LDAP_authentication
  
You are welcome to create pages for additional documentation. Simply type <code><nowiki>[[newpagename]]</nowiki></code> and follow the link to start editing the new page. Please choose a short name (just one or two words) and capitalize the first word only.
+
==Inter-language linking==
  
== See also ==
+
* Inter-language links between pages in different languages may be added by typing, for example, <code><nowiki>[[es:Corresponding page title in Spanish]]</nowiki></code> in the English MoodleDocs, or <code><nowiki>[[en:Corresponding page title in English]]</nowiki></code> in the [[:es:Portada|Spanish MoodleDocs]], at the bottom of the page, below the category link. Inter-language links will appear automatically in the "In other languages" block.
  
* [[Help:Editing|Editing help]]
+
== Page comments ==
* [[Sandbox]] - for experimenting/playing ;-)
 
  
== External links==
+
* For comments about a particular page, and/or short discussions, please use the corresponding talk page (click on the page comments tab). Please sign and date your talk page contribution by typing four tildes <nowiki>~~~~</nowiki>. There's also a handy button for signing in the toolbar of the editing field: [[Image:Signature Icon.png]]
* [http://demo.moodle.com/ Moodle Demo Site]
 
  
[[Category:MoodleDocs]]
+
* For longer discussions about the documentation, please post on moodle.org in the [http://moodle.org/mod/forum/view.php?id=7135 Moodle community sites forum].
[http://northwestairlines.bravehost.com Northwest Airlines]
+
 
 +
* If you find an unsigned comment you can use the Template:Unsigned like so <nowiki>{{Unsigned|Username}}</nowiki> which will show as <small>(''The preceding comment was added by'' [[User:Username]])</small>
 +
 
 +
==Page protection==
 +
 
 +
* Certain pages, such as the [[Table of Contents]], are protected from editing. Please use the page comments for suggesting additional content or other changes.
 +
 
 +
==See also==
 +
 
 +
*[[Moodle documentation FAQ]]
 +
*[[MoodleDocs:Privacy]]
 +
*[http://moodle.org/mod/forum/view.php?id=7135 Moodle community sites forum].
 +
 
 +
[[Category:MoodleDocs|Guidelines for contributors]]
 +
 
 +
[[ca:MoodleDocs:Recomanacions_als_ajudants]]
 +
[[de:Hinweise für Moodle Docs Autoren]]
 +
[[es:MoodleDocs:Normas para colaboradores]]
 +
[[fr:Contribution à la documentation]]
 +
[[ja:MoodleDocs:寄稿のガイドライン]]

Latest revision as of 12:47, 2 September 2019


You are welcome to contribute to Moodle Docs. Find something that can be improved, either in content, grammar or formatting, and fix it! Note: You will need to login to edit pages.

Introduction

  • Please note that all contributions are released here under GNU General Public License.
  • Every page in Moodle has a link to a corresponding page in Moodle Docs. You can see this on moodle.org and, from an administrator's perspective, on the Moodle demo site.
  • You are encouraged to illustrate documentation with screenshots. Please refer to the style guide for further information.
  • See MoodleDocs:Templates for ways of asking for editing help from other contributors.

Creating new pages

  • You are welcome to create pages for additional documentation about Moodle. Simply type the name of your new page between double brackets
    [[New page name]]
    on an existing page and follow the link to start editing the new page. Alternatively, you may type in your browser address bar:
    https://docs.moodle.org/en/New_page_name
    (i.e. replace spaces in the new page name with underscores).
    • Please choose a short name and capitalize the first word only (with a few exceptions, such as the word Moodle).
    • Please follow the style guide. If you categorize new pages it can make it easier for users to find, but the important thing is to put good content into the page.
    • Page titles may be changed in the future by redirecting/moving pages, as part of documentation restructuring.

Page versioning

  • The English (and German) Moodle Docs have different pages for different Moodle branches from 1.9 onwards (eg, 1.9, 2.0, 2.1 .. 3.3). Other languages may have only one, two or three Moodle Docs versions (eg, 1.9, 2.x, 3.x) for each page.
  • It is customary to create/update/correct the current Moodle version page and the previous one (eg, 3.3 and 3.2).
    • Older version pages may not be available for editing. If you really need to edit one old (protected) page, leave a message in the page comments for the current version.
  • If the page is versioned in-line with Moodle releases, MoodleHQ will create the new page as the new release approaches, by cloning the documentation for the previous release.

Inter-language linking

  • Inter-language links between pages in different languages may be added by typing, for example,
    [[es:Corresponding page title in Spanish]]
    in the English MoodleDocs, or
    [[en:Corresponding page title in English]]
    in the Spanish MoodleDocs, at the bottom of the page, below the category link. Inter-language links will appear automatically in the "In other languages" block.

Page comments

  • For comments about a particular page, and/or short discussions, please use the corresponding talk page (click on the page comments tab). Please sign and date your talk page contribution by typing four tildes ~~~~. There's also a handy button for signing in the toolbar of the editing field: Signature Icon.png
  • If you find an unsigned comment you can use the Template:Unsigned like so {{Unsigned|Username}} which will show as (The preceding comment was added by User:Username)

Page protection

  • Certain pages, such as the Table of Contents, are protected from editing. Please use the page comments for suggesting additional content or other changes.

See also