Difference between revisions of "GPC/Creating Project Wiki Pages"

From OWASP
Jump to: navigation, search
m
Line 7: Line 7:
  
 
Steps to creating a project on the OWASP Wiki:
 
Steps to creating a project on the OWASP Wiki:
# Determine Project Name
+
* Determine Project Name (e.g. “OWASP Example Project”)
# Create OWASP mailing list
+
* Create OWASP mailing list (e.g. “https://lists.owasp.org/mailman/listinfo/owasp-example-project”)
# Create main project page (/[project_name])
+
* Create Project Roadmap Page (e.g. https://www.owasp.org/index.php/Projects/OWASP_Example_Project/Roadmap )
# Create Project Roadmap Page (/Projects/[project_name]/Roadmap)
+
** In this wiki page, paste the text from the Incubator Project Application (roadmap column J)
# Create Project Metadata wiki page (/Projects/[project_name])
+
** Save the wii page
# Create Project Releases wiki page (/Projects/[project_name]/Releases)
+
* Create Project Metadata wiki page (e.g. https://www.owasp.org/index.php/Projects/OWASP_Example_Project )
# Add to Project Inventory Spreadsheet
+
** Type the syntax below and fill in details from the Incubator Project Application spreadsheet. It creates a Project About using this template: [[Template:Project_About]]
 +
<pre>
 +
{{Template:Project About
 +
| project_name =OWASP Example Project
 +
| project_home_page =OWASP Example Project
 +
| project_description =This is the description from column I of the Incubator Project Application spreadsheet
 +
| project_license =This is the license from column D of the Incubator Project Application spreadsheet
 +
| leader_name1 =This is the leader from column E of the Incubator Project Application spreadsheet
 +
| leader_email1 =This is the email @owasp.org created for the leader
 +
| leader_username1 =This is the wiki account for the leader
 +
| mailing_list_name = This is the full link to the mailing list (e.g. https://lists.owasp.org/mailman/listinfo/owasp-example-project)
 +
| project_road_map = This is name of the roadmap wiki page created in the previous step (e.g. Projects/OWASP_Example_Project/Roadmap)
 +
}}
 +
</pre>
 +
* Create main project page (e.g. https://www.owasp.org/index.php/OWASP_Example_Project )
 +
* Use the following syntax (replace Projects/OWASP_Example_Project with the appropriate Project Metadata wiki page created above)
 +
<pre>
 +
=Main=
 +
Project Leader’s content goes here
 +
 
 +
=Project About=
 +
{{:Projects/OWASP_Example_Project}}
 +
</pre>
 +
 
 +
* Add the just created project to the Project Inventory Spreadsheet with all the relevant details, wiki page, etc.

Revision as of 13:14, 29 July 2012

Steps to starting a project (paraphrased from draft Project Handbook:

  1. Submitter sends request via: new project request form
  2. Request generates an email to the GPC containing project submission
  3. All requests are held for a five day waiting period ("speedbump") for committee and community review/feedback. The proposal will be sent to the Global Projects Committee Mailing List: global-projects-committee@lists.owasp.org
  4. At the conclusion of the "speedbump" period, the project is created.

Steps to creating a project on the OWASP Wiki:

{{Template:Project About
| project_name =OWASP Example Project
| project_home_page =OWASP Example Project
| project_description =This is the description from column I of the Incubator Project Application spreadsheet
| project_license =This is the license from column D of the Incubator Project Application spreadsheet
| leader_name1 =This is the leader from column E of the Incubator Project Application spreadsheet
| leader_email1 =This is the email @owasp.org created for the leader
| leader_username1 =This is the wiki account for the leader
| mailing_list_name = This is the full link to the mailing list (e.g. https://lists.owasp.org/mailman/listinfo/owasp-example-project)
| project_road_map = This is name of the roadmap wiki page created in the previous step (e.g. Projects/OWASP_Example_Project/Roadmap)
}}
=Main=
Project Leader’s content goes here

=Project About=
{{:Projects/OWASP_Example_Project}} 
  • Add the just created project to the Project Inventory Spreadsheet with all the relevant details, wiki page, etc.