Template:Commissioning: Difference between revisions

From CoMakingSpace Wiki

(..)
m (wording)
 
(18 intermediate revisions by 2 users not shown)
Line 1: Line 1:
''This tool is not ready for usage yet, since not all commissioning steps are completed yet. The Process is also tracked on [https://github.com/comakingspace/do-something/issues/{{{IssueNumber|}}} github]''
''This tool is '''not ready for use''' yet since not all [[commissioning]] steps have been completed. {{#if: {{{IssueNumber|}}} | The process is also [https://github.com/comakingspace/do-something/issues/{{{IssueNumber|}}} tracked on GitHub]| The process is not yet tracked on [https://github.com/comakingspace/do-something/issues/{{{IssueNumber|}}} GitHub]}}. Feel free to contribute to making it usable, any help is very welcome!''
 
{| class="wikitable"
{| class="wikitable"
|-
|-
!Task !! comment !!  Status  
!Task !! comment !!  Status  
|-
|-
| Name the tool: || {{#if: {{{naming|}}} | {{{naming}}} | - }}  {{{NamingComment|-}}} || {{#if: {{{naming|}}} | {{{naming}}} | pending}}
| Name the tool: || {{#if: {{{NamingComment|}}} | {{{NamingComment}}} | - }}  || {{#if: {{{Naming|}}} | {{{Naming}}} | pending}}
|-
|-
| Take a picture || {{#if: {{{PictureComment|}}} | {{{PictureComment}}} | - }} || {{#if: {{{Picture|}}} | {{{Picture}}} | pending}}  
| Take a picture || {{#if: {{{PictureComment|}}} | {{{PictureComment}}} | - }} || {{#if: {{{Picture|}}} | {{{Picture}}} | pending}}  
|-
| Find the manual as PDF || {{#if: {{{ManualComment|}}} | {{{ManualComment}}} | needed for all [[machines]] - add a link to the InfoBox or comment where you could ''not'' find it }} || {{#if: {{{Manual|}}} | {{{Manual}}} | pending}}
|-
|-
| Documentation ||{{#if: {{{DocumentationComment|}}} | {{{DocumentationComment}}} | this page, status: in commissioning }} || {{#if: {{{Documentation|}}} | {{{Documentation}}} | pending}}
| Documentation ||{{#if: {{{DocumentationComment|}}} | {{{DocumentationComment}}} | this page, status: in commissioning }} || {{#if: {{{Documentation|}}} | {{{Documentation}}} | pending}}
|-
|-
| Introduction ||{{#if: {{{IntroductionComment|}}} | {{{IntroductionComment}}} | - }}  ||{{#if: {{{Introduction|}}} | {{{Introduction}}} | pending}}
| Print QR-Code ||{{#if: {{{QRComment|}}} | {{{QRComment}}} | use the [https://github.com/comakingspace/CommonFiles/tree/master/Printouts/QRCodes wikicrawler] }} || {{#if: {{{QR|}}} | {{{QR}}} | pending [[Category:MissingQR]]}}
|-
| [[Introduction]] ||{{#if: {{{IntroductionComment|}}} | {{{IntroductionComment}}} | - }}  || {{#if: {{{Introduction|}}} | {{{Introduction}}} | pending}}
|-
|-
| Security Check ||{{#if: {{{SecurityComment|}}} | {{{SecurityComment}}} | to be done or witnessed by a manager }}  ||{{#if: {{{Security|}}} | {{{Security}}} | pending}}
| Security Check ||{{#if: {{{SecurityComment|}}} | {{{SecurityComment}}} | to be done or witnessed by a [[manager]] }}  || {{#if: {{{Security|}}} | {{{Security}}} | pending}}
|-
|-
| Test ||{{#if: {{{TestingComment|}}} | {{{TestingComment}}} | to be done or witnessed by a manager}} ||{{#if: {{{Test|}}} | {{{Test}}} | pending}}
| Test ||{{#if: {{{TestComment|}}} | {{{TestComment}}} | to be done or witnessed by a [[manager]]}} ||{{#if: {{{Test|}}} | {{{Test}}} | pending}}
|-
|-
| Make it available ||{{#if: {{{AvailabilityComment|}}} | {{{AvailabilityComment}}} | pyhsically and in the wiki - then delete this Template }} ||{{#if: {{{Availability|}}} | {{{Availability}}} | pending}}
| tool's name, owner and approx. value ||{{#if: {{{OwnerValueComment|}}} | {{{OwnerValueComment}}} | provide to {{inventory-manager}} for inventorization}} ||{{#if: {{{OwnerValue |}}} | {{{OwnerValue }}} | pending}}
|-
|-
| tool's name, owner and approx. value ||{{#if: {{{OwnerValueComment|}}} | {{{OwnerValueComment}}} | Provide to a manager }} ||{{#if: {{{OwnerValue |}}} | {{{OwnerValue }}} | pending}}
| '''Last''' step: make it available ||{{#if: {{{AvailabilityComment|}}} | {{{AvailabilityComment}}} | physically and in the wiki - then delete this template }} ||{{#if: {{{Availability|}}} | {{{Availability}}} | pending}}
|}
|}
[[Category:Commissioning]]
[[Category:Commissioning]]


<noinclude>
<noinclude>
This Template marks a tool as not usable yet, since it was not fully commissioned. The steps needed to make a new tool available are discussed in [https://github.com/comakingspace/do-something/issues/42 #42].
== Documentation ==
<templatedata>
{
"params": {
"IssueNumber": {
"label": "Issue Number",
"description": "Marks the commissioning progess as being discussed on GitHub and adds a link to the respective issue",
"example": "223",
"default": "Default link to the issue tracker",
"type": "number",
"suggested": true
},
"NamingComment": {
"description": "Provides a comment with further information regarding \"Name: Status\" if needed.",
"type": "string",
"label": "Name: Comment",
"default": "pending"
},
"Naming": {
"label": "Name: Status",
"type": "string",
"description": "Indicates the status of providing the name of the new machine.",
"suggested": true
},
"PictureComment": {
"label": "Picture: Comment",
"description": "Provides a comment with further information regarding \"Picture: Status\" if needed.",
"type": "string"
},
"Picture": {
"label": "Picture: Status",
"description": "Indicates the status of taking a picture of the new machine",
"type": "string",
"default": "pending",
"suggested": true
},
"ManualComment": {
"label": "Manual: Comment",
"description": "Provides a comment with further information regarding \"Manual: Status\" if needed.",
"type": "string"
},
"Manual": {
"label": "Manual: Status",
"description": "Indicates the status of providing the manual of the new machine.",
"type": "string",
"default": "pending",
"suggested": true
},
"DocumentationComment": {
"label": "Documentation: Comment",
"description": "Provides a comment with further information regarding \"Documentation: Status\" if needed.",
"type": "string"
},
"Documentation": {
"label": "Documentation: Status",
"description": "Indicates the status of providing proper documentation of the new machine in our wiki.",
"type": "string",
"default": "pending",
"suggested": true
},
"QRComment": {
"label": "QR Code: Comment",
"description": "Provides a comment with further information regarding \"QR Code: Status\" if needed.",
"type": "string"
},
"QR": {
"label": "QR Code: Status",
"description": "Indicates the status of printing the QR Code of the new machine using the wikicrawler",
"type": "string",
"default": "pending",
"suggested": true
},
"IntroductionComment": {
"label": "Introduction: Comment",
"description": "Provides a comment with further information regarding \"Introduction: Status\" if needed.",
"type": "string"
},
"Introduction": {
"label": "Introduction: Status",
"description": "Indicates the status of providing a proper introduction for the new machine. Status should be set by a manager",
"type": "string",
"default": "pending",
"suggested": true
},
"SecurityComment": {
"label": "Security Check: Comment",
"description": "Provides a comment with further information regarding \"Security Check: Status\" if needed.",
"type": "string"
},
"Security": {
"label": "Security Check: Status",
"description": "Indicates the status of the security check of the machine. Security checks need to be done by/with a manager.",
"type": "string",
"default": "pending",
"suggested": true
},
"TestComment": {
"label": "Test: Comment",
"description": "Provides a comment with further information regarding \"Test: Status\" if needed.",
"type": "string"
},
"Test": {
"label": "Test: Status",
"description": "Indicates the status of testing the new machine. Testing needs to be done by/with a manager.",
"type": "string",
"default": "pending",
"suggested": true
},
"OwnerValueComment": {
"label": "Owner / Value: Comment",
"description": "Provides a comment with further information regarding \"Owner / Value: Status\" if needed.",
"type": "string"
},
"OwnerValue": {
"label": "Owner / Value: Status",
"description": "Indicates the status of providing the name of the owner and the value of the new machine to the community manager for inventorization.",
"type": "string",
"default": "pending",
"suggested": true
},
"AvailabilityComment": {
"label": "Availability: Comment",
"description": "Provides a comment with further information regarding \"Availability: Status\" if needed.",
"type": "string"
},
"Availability": {
"label": "Availability: Status",
"description": "Indicates the status of making the machine available. This must be edited by managers only!",
"type": "string",
"default": "pending",
"suggested": true
}
},
"description": "This template marks a tool as not usable yet, since it was not fully [[commissioned]]."
}
</templatedata>
 


== Documentation ==
To use this template, simply insert this code at the top of your page and enter the relevant parameters:
To use this template, simply insert this code at the top of your page and enter the relevant parameters:
<pre>
{{Commissioning
{{Commissioning
|IssueNumber=42
|IssueNumber=42
|naming=test
|Naming=
|NamingComment=
|NamingComment=
|Picture=
|Picture=
|PictureComment=
|PictureComment=
|Manual=
|ManualComment=
|Documentation=
|Documentation=
|DocumentationComment=
|DocumentationComment=
|QR=
|QRComment=
|Introduction=
|Introduction=
|IntroductionComment=
|IntroductionComment=
Line 40: Line 185:
|SecurityComment=
|SecurityComment=
|Test=
|Test=
|TestingComment=
|TestComment=
|OwnerValue=
|OwnerValueComment=
|Availability=
|Availability=
|AvailabilityComment=
|AvailabilityComment=
|OwnerValue=
|OwnerValueComment=
}}
}}
</pre>
</noinclude>
</noinclude>

Latest revision as of 12:37, 24 October 2021

This tool is not ready for use yet since not all commissioning steps have been completed. The process is not yet tracked on GitHub. Feel free to contribute to making it usable, any help is very welcome!

Task comment Status
Name the tool: - pending
Take a picture - pending
Find the manual as PDF needed for all machines - add a link to the InfoBox or comment where you could not find it pending
Documentation this page, status: in commissioning pending
Print QR-Code use the wikicrawler pending
Introduction - pending
Security Check to be done or witnessed by a manager pending
Test to be done or witnessed by a manager pending
tool's name, owner and approx. value provide to Patrick for inventorization pending
Last step: make it available physically and in the wiki - then delete this template pending


Documentation

This template marks a tool as not usable yet, since it was not fully [[commissioned]].

Template parameters

ParameterDescriptionTypeStatus
Issue NumberIssueNumber

Marks the commissioning progess as being discussed on GitHub and adds a link to the respective issue

Default
Default link to the issue tracker
Example
223
Numbersuggested
Name: CommentNamingComment

Provides a comment with further information regarding "Name: Status" if needed.

Default
pending
Stringoptional
Name: StatusNaming

Indicates the status of providing the name of the new machine.

Stringsuggested
Picture: CommentPictureComment

Provides a comment with further information regarding "Picture: Status" if needed.

Stringoptional
Picture: StatusPicture

Indicates the status of taking a picture of the new machine

Default
pending
Stringsuggested
Manual: CommentManualComment

Provides a comment with further information regarding "Manual: Status" if needed.

Stringoptional
Manual: StatusManual

Indicates the status of providing the manual of the new machine.

Default
pending
Stringsuggested
Documentation: CommentDocumentationComment

Provides a comment with further information regarding "Documentation: Status" if needed.

Stringoptional
Documentation: StatusDocumentation

Indicates the status of providing proper documentation of the new machine in our wiki.

Default
pending
Stringsuggested
QR Code: CommentQRComment

Provides a comment with further information regarding "QR Code: Status" if needed.

Stringoptional
QR Code: StatusQR

Indicates the status of printing the QR Code of the new machine using the wikicrawler

Default
pending
Stringsuggested
Introduction: CommentIntroductionComment

Provides a comment with further information regarding "Introduction: Status" if needed.

Stringoptional
Introduction: StatusIntroduction

Indicates the status of providing a proper introduction for the new machine. Status should be set by a manager

Default
pending
Stringsuggested
Security Check: CommentSecurityComment

Provides a comment with further information regarding "Security Check: Status" if needed.

Stringoptional
Security Check: StatusSecurity

Indicates the status of the security check of the machine. Security checks need to be done by/with a manager.

Default
pending
Stringsuggested
Test: CommentTestComment

Provides a comment with further information regarding "Test: Status" if needed.

Stringoptional
Test: StatusTest

Indicates the status of testing the new machine. Testing needs to be done by/with a manager.

Default
pending
Stringsuggested
Owner / Value: CommentOwnerValueComment

Provides a comment with further information regarding "Owner / Value: Status" if needed.

Stringoptional
Owner / Value: StatusOwnerValue

Indicates the status of providing the name of the owner and the value of the new machine to the community manager for inventorization.

Default
pending
Stringsuggested
Availability: CommentAvailabilityComment

Provides a comment with further information regarding "Availability: Status" if needed.

Stringoptional
Availability: StatusAvailability

Indicates the status of making the machine available. This must be edited by managers only!

Default
pending
Stringsuggested


To use this template, simply insert this code at the top of your page and enter the relevant parameters: 

{{Commissioning
|IssueNumber=42
|Naming=
|NamingComment=
|Picture=
|PictureComment=
|Manual=
|ManualComment=
|Documentation=
|DocumentationComment=
|QR=
|QRComment=
|Introduction=
|IntroductionComment=
|Security=
|SecurityComment=
|Test=
|TestComment=
|OwnerValue=
|OwnerValueComment=
|Availability=
|AvailabilityComment=
}}


Retrieved from "https://wiki.comakingspace.de/index.php?title=Template:Commissioning&oldid=10639"