MoodleDocs:Guidelines for contributors: Difference between revisions
From MoodleDocs
James Neill (talk | contribs) (==Page protection== * Some pages are protected from editing. For these pages, try contributing via the associated talk page or forking (i.e., copying the page to another name, then editing).) |
Helen Foster (talk | contribs) m (removing ru link as there is no ru wiki) |
||
| (44 intermediate revisions by 17 users not shown) | |||
| Line 1: | Line 1: | ||
{{Help}} | {{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. | ||
==Introduction== | ==Introduction== | ||
* Please note that all contributions are released here under [[License|GNU General Public License]]. | * Please note that all contributions are released here under [[License|GNU General Public License]]. | ||
* | * 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 [http://demo.moodle.net/ Moodle demo site]. | ||
* You are encouraged to illustrate documentation with screenshots. Please refer to the [[MoodleDocs:Style guide|style guide]] for further information. | * 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. | ||
==Creating new pages== | ==Creating new pages== | ||
* You are welcome to create pages for additional documentation. 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). | * 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 choose a short name and capitalize the first word only (with a few exceptions, such as the word ''Moodle''). | * 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. | * 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. | * Page titles may be changed in the future by redirecting/moving pages, as part of documentation restructuring. | ||
| Line 19: | Line 17: | ||
==Inter-language linking== | ==Inter-language linking== | ||
* | * 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. | ||
== | == 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 <nowiki>~~~~</nowiki>. There's also a handy button for signing in the toolbar of the editing field: [[Image:Signature Icon.png]] | ||
= | * 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]. | ||
* | * 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== | ==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]] | |||
*[http://moodle.org/mod/forum/view.php?id=7135 Moodle community sites forum]. | |||
[[Category:MoodleDocs|Guidelines for contributors]] | [[Category:MoodleDocs|Guidelines for contributors]] | ||
[[ca:MoodleDocs:Recomanacions_als_ajudants]] | |||
[[de:Hinweise für Moodle Docs Autoren]] | |||
[[es:MoodleDocs:Normas para colaboradores]] | [[es:MoodleDocs:Normas para colaboradores]] | ||
[[fr: | [[fr:Contribution à la documentation]] | ||
[[ja:MoodleDocs:寄稿のガイドライン]] | [[ja:MoodleDocs:寄稿のガイドライン]] | ||
Latest revision as of 14:05, 14 September 2016
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.
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:
- For longer discussions about the documentation, please post on moodle.org in the Moodle community sites forum.
- 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 seri ayu)
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.
