Difference between revisions of "Template:Project Facts"
From fd.io
| Line 1: | Line 1: | ||
| − | { | + | {| class="wikitable" style="color:#C95000; background-color:#FFE6CD; margin-left: 10px;" align="right" border="1" |
| − | | | + | |align="center"|'''{{{name}}} Facts''' |
| − | + | |- | |
| − | | | + | | |
| − | | | + | '''Project Lead:''' {{{projectLead}}}<br> |
| − | | | + | '''Committers:'''<br> |
| − | + | {{{committers}}} <br> | |
| − | + | '''Repository:''' {{{repo|{{#if:{{{shortname|}}}|git clone https://gerrit.fd.io/r/{{{shortname}}}|unspecified}} }}}<br> | |
| − | + | '''Mailing List:''' {{{mailingList|{{#if:{{{shortname|}}}|[https://lists.fd.io/mailman/listinfo/{{{shortname}}}-dev {{{shortname}}}<nowiki>-dev@lists.fd.io</nowiki>]|unspecified}} }}}<br> | |
| − | + | '''Jenkins:''' {{{jenkins|{{#if:{{{shortname|}}}|[https://jenkins.fd.io/view/{{{shortname}}}/ jenkins silo]|unspecified}} }}}<br> | |
| − | + | '''Gerrit Patches:''' {{{gerrit|{{#if:{{{shortname|}}}|[https://gerrit.fd.io/r/#/q/project:{{{shortname}}} code patches/reviews]|unspecified}} }}}<br> | |
| − | + | '''Bugs:''' {{{jira|{{#if:{{{jiraName|}}}|[https://jira.fd.io/projects/{{{jiraName}}} {{{jiraName}}} bugs]|unspecified}} }}}<br> | |
| − | + | |}<noinclude> | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | }} | + | |
| − | + | ||
| − | + | <font color="red">'''NOTE:''' This template should be used only for officially approved fd.io projects.</font> | |
| − | + | This Project Facts template is used to give people an at-a-glance view of the core information about a project and also used to track the current projects in fd.io. | |
| − | + | ||
| − | + | ==Usage== | |
| − | + | The template is designed to automagically fill out the mailing list, jenkins, gerrit patches, and bugs if you just fill in the <tt>shortname</tt> variable. The other fields need to be specified by hand. See any of the pages above for examples. | |
| − | + | === Fields === | |
| − | = | + | The template supports the following fields. Optional ones are called out in ''italics'' and labeled with "(optional)". Automagically populated fields are also called out. <font color="red">''Note that field names are case sensitive.''</font> |
| − | + | * <tt>projectLead</tt> | |
| + | * <tt>committers</tt> | ||
| + | * <tt>name</tt> | ||
| + | * <tt>shortname</tt>: automagically populates the six shown sub-fields, but you can override it by explicitly defining them as well. | ||
| + | ** <tt>''gerrit''</tt> (optional) | ||
| + | ** <tt>''jenkins''</tt> (optional) | ||
| + | ** <tt>''repo''</tt> (optional) | ||
| − | + | ==Categories== | |
| − | + | This template adds certain categories to pages that use it. First, it adds the "Project Main Pages" category any page. As a consequence, a list of the pages using this template can be found here: [[:Category:Project Main Pages]]. | |
| − | + | To include that list inside of another page you can use: | |
| − | === | + | <tt><nowiki><DynamicPageList></nowiki><br/> |
| + | category = Project Main Pages<br/> | ||
| + | ordermethod = categorysortkey<br/> | ||
| + | order = ascending<br/> | ||
| + | <nowiki></DynamicPageList></nowiki></tt> | ||
| − | + | Like this: | |
| − | + | <DynamicPageList> | |
| − | + | category = Project Main Pages | |
| − | + | ordermethod = categorysortkey | |
| + | order = ascending | ||
| + | </DynamicPageList> | ||
| − | + | Note that indirectly adding a category to a page like this is not instantaneous in mediawiki, but will instead be [http://en.wikipedia.org/wiki/Help:Category#Categories_and_templates processed by the job queue] and then they will be marked as in the appropriate category. You can accelerate this process by performing a [http://en.wikipedia.org/wiki/Help:Null_edit#Null_edit null edit]. | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | == | + | ===Project State Categories=== |
| − | + | This template also automatically, adds the "${project state} Projects" category to the page, so we can produce a category for each project state and thus we can list them out very easily as follows: | |
| − | == | + | '''Incubation Projects:''' |
| + | <DynamicPageList> | ||
| + | category = Incubation Projects | ||
| + | ordermethod = categorysortkey | ||
| + | order = ascending | ||
| + | </DynamicPageList> | ||
| − | + | '''Bootstrap Projects:''' | |
| + | <DynamicPageList> | ||
| + | category = Bootstrap Projects | ||
| + | ordermethod = categorysortkey | ||
| + | order = ascending | ||
| + | </DynamicPageList> | ||
| − | + | Note: This requires that the state be spelled and capitalized consistently.</noinclude><includeonly>[[Category:Project Main Pages]]</includeonly> | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | < | + | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
Revision as of 03:50, 9 November 2018
| {{{name}}} Facts |
|
Project Lead: {{{projectLead}}} |
NOTE: This template should be used only for officially approved fd.io projects.
This Project Facts template is used to give people an at-a-glance view of the core information about a project and also used to track the current projects in fd.io.
Usage
The template is designed to automagically fill out the mailing list, jenkins, gerrit patches, and bugs if you just fill in the shortname variable. The other fields need to be specified by hand. See any of the pages above for examples.
Fields
The template supports the following fields. Optional ones are called out in italics and labeled with "(optional)". Automagically populated fields are also called out. Note that field names are case sensitive.
- projectLead
- committers
- name
- shortname: automagically populates the six shown sub-fields, but you can override it by explicitly defining them as well.
- gerrit (optional)
- jenkins (optional)
- repo (optional)
Categories
This template adds certain categories to pages that use it. First, it adds the "Project Main Pages" category any page. As a consequence, a list of the pages using this template can be found here: Category:Project Main Pages.
To include that list inside of another page you can use:
<DynamicPageList>
category = Project Main Pages
ordermethod = categorysortkey
order = ascending
</DynamicPageList>
Like this:
- Archived-Deb dpdk
- Archived-DMM
- Archived-Hc2vpp
- Archived-Honeycomb
- Archived-JVPP
- Archived-NSH SFC
- Archived-ODP4VPP
- Archived-ONE
- Archived-P4vpp
- Archived-Pma tools
- Archived-Puppet-fdio
- Archived-Rpm dpdk
- Archived-Sweetcomb
- Archived-TLDK
- Ci-management
- Cicn
- CSIT
- GoVPP
- HICN
- TRex
- UDPI
- VPP
- VPP Sandbox
- VSAP
Note that indirectly adding a category to a page like this is not instantaneous in mediawiki, but will instead be processed by the job queue and then they will be marked as in the appropriate category. You can accelerate this process by performing a null edit.
Project State Categories
This template also automatically, adds the "${project state} Projects" category to the page, so we can produce a category for each project state and thus we can list them out very easily as follows:
Incubation Projects: No pages meet these criteria.
Bootstrap Projects: No pages meet these criteria.
Note: This requires that the state be spelled and capitalized consistently.
