THE SPDX WIKI IS NO LONGER ACTIVE. ALL CONTENT HAS BEEN MOVED TO https://github.com/spdx

Difference between revisions of "Wiki Conventions"

From SPDX Wiki
Jump to: navigation, search
m (Update link to getting started page)
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
<h2>First:</h2><ul><li>You need an account in order to edit the wiki pages. If you haven't created an account on FOSSBazaar or spdx.org yet, please <a href="/user/register">sign up</a> for one now. If you already have a FOSSBazaar account, you can use it login here.</li><li>There are three separate SPDX teams (Technical, Business and Legal) each of which has its own meetings and mailing list. There is also a regular General Meeting and mailing list, the main purposes of which is to report out on team activities. Here you can subscribe to the <a href="http://lists.spdx.org/mailman/listinfo/spdx">SPDX mailing list</a>&nbsp;which is a good way for anyone with casual interest to participate and be notified of general meetings. To participate on the teams or get on the team mailing lists, go to their respective sections under the Participation tab.</li><li>A good starting point for understanding the spec is the <a href="http://www.linuxfoundation.org/sites/main/files/publications/lf_foss_compliance_spdx.pdf">SPDX whitepaper</a>. This <a href="http://www.blackducksoftware.com/files/spdx/intro_to_spdx.mov">3 minute webinar</a> provides a very concise introduction.</li><li>Another good resource is the <a title="SPDX mailing list archive" href="http://lists.spdx.org/pipermail/spdx/">mailing list archive</a>.</li></ul><h2>Wiki</h2><p>Here are some instructions for using the SPDX wiki. Every user who is logged into spdx.org can modify wiki pages. At the top of a page, you'll see an "Edit" option. You can then edit the page using the HTML editor. When you save the page, make sure to put in a message in "Log message" briefly explaining the change you've made. Then click on "Save" at the bottom of the page to save or on "Preview" or "Preview changes" to preview before saving.</p><p>If a page has been edited more than once, you'll see a "Revisions" link at the top of the page (next to "Edit"). Clicking on this link will allow you to see in detail which changes have been made to the page.</p><p>If you want to create a new page, click on "Add child page".</p><p>If you want to add a visible comment,&nbsp; please start the comment by indicating the source by your initials, bolded, surrounded by angle brackets.&nbsp; Then put the comment itself in italics.&nbsp; For example: <strong>&lt;kes&gt;</strong> <em>this is a comment or a question?.</em>&nbsp; The purpose of this is to make sure its clear that this is not part of the official text of the standard at this point, and provides localized context for the discussion.</p>
+
This page describes conventions that should be followed on the SPDX wiki. You can also read the page on [[Getting started with the SPDX wiki|getting started]].
 +
 
 +
== SubPages ==
 +
 
 +
This wiki uses subpages to provide a hierarchy. For example, the minutes for the business team are located under <code>Business Team/Minutes</code>.
 +
 
 +
When you add a new page, please make sure to use the correct hierarchy. If you want to create a new business related page, choose <code>Business Team/name of page</code> If you'd like to add new business minutes, add them as <code>Business Team/Minutes/YYYY-MM-DD</code>
 +
 
 +
== Categories ==
 +
 
 +
We use [[Special:Categories|categories]] to organize pages.  You should add one of these categories at the bottom of each new page:
 +
* <nowiki>[[Category:Business]]</nowiki>
 +
* <nowiki>[[Category:General]]</nowiki>
 +
* <nowiki>[[Category:Legal]]</nowiki>
 +
* <nowiki>[[Category:Technical]]</nowiki>
 +
 
 +
== Adding minutes ==
 +
 
 +
The list of minutes is updated automatically but this requires minutes to be added in the right location.  Please use <code>XXX Team/Minutes/YYYY-MM-DD</code> for new minutes.
 +
 
 +
Additionally, minutes should have the category <nowiki>[[Category:Minutes]]</nowiki> in addition to the category defining the subject area.
 +
 
 +
== Headings ==
 +
 
 +
Make sure not to use a heading starting with <nowiki>=</nowiki> as this reserved for the title of the page. Headings should start with <nowiki>==</nowiki>. See the [http://www.mediawiki.org/wiki/Help:Formatting MediaWiki wiki syntax] page for more information.
 +
 
 +
== Commenting on pages ==
 +
 
 +
If you'd like to comment on pages, please click on "discussion" on the top of a page.

Latest revision as of 12:53, 12 April 2013

This page describes conventions that should be followed on the SPDX wiki. You can also read the page on getting started.

SubPages

This wiki uses subpages to provide a hierarchy. For example, the minutes for the business team are located under Business Team/Minutes.

When you add a new page, please make sure to use the correct hierarchy. If you want to create a new business related page, choose Business Team/name of page If you'd like to add new business minutes, add them as Business Team/Minutes/YYYY-MM-DD

Categories

We use categories to organize pages. You should add one of these categories at the bottom of each new page:

  • [[Category:Business]]
  • [[Category:General]]
  • [[Category:Legal]]
  • [[Category:Technical]]

Adding minutes

The list of minutes is updated automatically but this requires minutes to be added in the right location. Please use XXX Team/Minutes/YYYY-MM-DD for new minutes.

Additionally, minutes should have the category [[Category:Minutes]] in addition to the category defining the subject area.

Headings

Make sure not to use a heading starting with = as this reserved for the title of the page. Headings should start with ==. See the MediaWiki wiki syntax page for more information.

Commenting on pages

If you'd like to comment on pages, please click on "discussion" on the top of a page.

Retrieved from "https://wiki.spdx.org/index.php?title=Wiki_Conventions&oldid=2402"