Template

Difference between revisions of "Bot steps/Documentation"

< Template:Bot steps

(Created page with "This template keeps track of the progress on the various '''steps for bot integration''' on a new wiki. Actual development might slightly differ from the steps shown here. ==...")
 
m (Pamputt moved page Template:Bot cycle/Documentation to Template:Bot steps/Documentation without leaving a redirect: Part of translatable page "Template:Bot cycle/Documentation")
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
This template keeps track of the progress on the various '''steps for bot integration''' on a new wiki. Actual development might slightly differ from the steps shown here.
+
<noinclude><languages /></noinclude><translate><!--T:1-->
 +
This '''bot creation steps''' template track of the progress on the various localized bots. Actual development might slightly differ from the steps shown here.
  
−
== General parameters ==
+
== General parameters == <!--T:2-->
−
# <code>isolang</code>: code of the target language.
 
−
# <code>requester</code>: username of the requester.
 
−
# <code>assigned</code>: username of the developer assigned to the request.
 
−
# <code>botmaster</code>: username of the botmaster ([[User:Poslovitch]] by default).
 
  
−
== Steps at creation ==
+
<!--T:3-->
−
# <code>request</code>: The requester from an external wiki has posted their request on [[LinguaLibre:Bot]]
+
# <tvar|wmlang><code>wmlang</code></>: code used by the Wikimedia projects of the target language.
−
# <code>discussion</code>: The request is taken into account, any additional information that would be needed for development is asked to the requester.
+
# <tvar|requester><code>requester</code></>: username of the requester.
−
# <code>community-approval</code>: The requester ensures that the community of the target wiki is aware and willing to use LinguaLibreBot.
+
# <tvar|programmer><code>programmer</code></>: username of the developer assigned to the request.
−
# <code>account</code>: The botmaster creates the local LinguaLibreBot account on the target wiki.
+
# <tvar|botmaster><code>botmaster</code></>: username of the botmaster ([[User:Poslovitch|Poslovitch]] by default).
−
# <code>code</code>: The developer assigned to the request writes the script.
 
−
# <code>test</code>: The developer assigned to the request tested their script on the target wiki.
 
−
# <code>botflag-request</code>: The bot flag for LinguaLibreBot has been requested on the target wiki, either after the tests ran by the developer, or before (in the event that the target wiki requires the intervention of stewarts).
 
−
# <code>pr-created</code>: The developer creates the pull request on GitHub.
 
−
# <code>botflag-ok</code>: The bot flag for LinguaLibreBot is granted.
 
−
# <code>pr-merged</code>: Once the code is tested and the bot flag is applied, the botmaster merges the pull request.
 
−
# <code>deployed</code>: The botmaster deploys the target wiki integration on Toolforge.
 
−
# <code>notification</code>: The botmaster or the developer notifies the requester and the community of the target wiki that the bot is active.
 
−
# <code>tested-real-conditions</code>: The bot has been successfully running on the target wiki for more than a week. Integration of the bot is deemed complete.
 
  
−
== Template usage ==
+
== Steps at creation == <!--T:4-->
 +
 
 +
<!--T:5-->
 +
# <tvar|request><code>request</code></>: The requester from an external wiki has posted their request on <tvar|1>[[LinguaLibre:Bot]]</>
 +
# <tvar|define><code>define</code></>: The request is taken into account, any additional information that would be needed for development is asked to the requester.
 +
# <tvar|community-approval><code>community-approval</code></>: The requester ensures the target wiki's community is aware and willing to use LinguaLibreBot.
 +
# <tvar|account><code>account</code></>: The botmaster creates the local LinguaLibreBot account on the target wiki.
 +
# <tvar|code><code>code</code></>: The developer assigned to the request writes the script.
 +
# <tvar|test><code>test</code></>: The developer assigned to the request tested their script on the target wiki.
 +
# <tvar|botflag-request><code>botflag-request</code></>: The bot flag for LinguaLibreBot has been requested on the target wiki, either after the tests ran by the developer, or before (in the event that the target wiki requires the intervention of stewarts).
 +
# <tvar|pr-created><code>pr-created</code></>: The developer creates the pull request on GitHub.
 +
# <tvar|botflag-ok><code>botflag-ok</code></>: The bot flag for LinguaLibreBot is granted.
 +
# <tvar|pr-merged><code>pr-merged</code></>: Once the code is tested and the bot flag is applied, the botmaster merges the pull request.
 +
# <tvar|deployed><code>deployed</code></>: The botmaster deploys the target wiki integration on Toolforge.
 +
# <tvar|notification><code>notification</code></>: The botmaster or the developer notifies the requester and the community of the target wiki that the bot is active.
 +
# <tvar|tested-real-conditions><code>tested-real-conditions</code></>: The bot has been successfully running on the target wiki for more than a week. Integration of the bot is deemed complete.
 +
 
 +
== Template usage == <!--T:6-->
 +
</translate>
 
{| class="wikitable"
 
{| class="wikitable"
 
! Code || Result
 
! Code || Result
 
|-
 
|-
 
|
 
|
 +
<!-- Notes :
 +
1) these are key hints, descriptors do the clarifications ;
 +
2) move to verbs ?
 +
3) x= the action is "checked, ok, done"
 +
4) an hand of parameters may require their twin `action-url=` parameter. Ex:
 +
- community-url = url to community discussion
 +
- botflag-url = url to botflag discussion
 +
5) back up words ideas :
 +
|ping=x (announce to individual)
 +
|announce=x
 +
|submit, submit-code, accept-code=x
 +
|merge=x
 +
|notify=
 +
|help=
 +
|wait=
 +
|active=
 +
-->
 
<pre>
 
<pre>
−
{{Bot cycle
+
{{Bot steps
 
|request=x
 
|request=x
 
|define=x
 
|define=x
 +
|community=x
 +
|account=x
 
|code=x
 
|code=x
−
|submit=x
+
|test=x
−
|merge=x
+
|botflag-request=x
−
|ping=x
+
|pr-created=x
−
|notification=
+
|botflag-ok=x
−
|help=
+
|pr-merged=x
−
|wait=
+
|deployed=x
−
|active=
+
|notification=x
 +
|tested-real-conditions=x
  
−
|isolang=ori
+
|wmlang=or
−
|requestee=Psubhashish
+
|requester=Psubhashish
−
|botmaster=Poslovitch,Pamputt
+
|programmer=Pamputt
 +
|botmaster=Poslovitch
 
}}</pre>
 
}}</pre>
 
|
 
|
−
{{Bot cycle
+
{{Bot steps
 
|request=x
 
|request=x
 
|define=x
 
|define=x
Line 57: Line 84:
 
|active=
 
|active=
  
−
|isolang=ori
+
|wmlang=or
 
|requestee=Psubhashish
 
|requestee=Psubhashish
 
|botmaster=Poslovitch,Pamputt
 
|botmaster=Poslovitch,Pamputt
 
}}
 
}}
 
|}
 
|}

Latest revision as of 10:28, 13 November 2021

Other languages:
Deutsch • ‎English • ‎brezhoneg • ‎français • ‎occitan • ‎sicilianu • ‎svenska • ‎македонски

This bot creation steps template track of the progress on the various localized bots. Actual development might slightly differ from the steps shown here.

General parameters

  1. wmlang: code used by the Wikimedia projects of the target language.
  2. requester: username of the requester.
  3. programmer: username of the developer assigned to the request.
  4. botmaster: username of the botmaster (Poslovitch by default).

Steps at creation

  1. request: The requester from an external wiki has posted their request on LinguaLibre:Bot
  2. define: The request is taken into account, any additional information that would be needed for development is asked to the requester.
  3. community-approval: The requester ensures the target wiki's community is aware and willing to use LinguaLibreBot.
  4. account: The botmaster creates the local LinguaLibreBot account on the target wiki.
  5. code: The developer assigned to the request writes the script.
  6. test: The developer assigned to the request tested their script on the target wiki.
  7. botflag-request: The bot flag for LinguaLibreBot has been requested on the target wiki, either after the tests ran by the developer, or before (in the event that the target wiki requires the intervention of stewarts).
  8. pr-created: The developer creates the pull request on GitHub.
  9. botflag-ok: The bot flag for LinguaLibreBot is granted.
  10. pr-merged: Once the code is tested and the bot flag is applied, the botmaster merges the pull request.
  11. deployed: The botmaster deploys the target wiki integration on Toolforge.
  12. notification: The botmaster or the developer notifies the requester and the community of the target wiki that the bot is active.
  13. tested-real-conditions: The bot has been successfully running on the target wiki for more than a week. Integration of the bot is deemed complete.

Template usage

Code Result 
{{Bot steps
|request=x
|define=x
|community=x
|account=x
|code=x
|test=x
|botflag-request=x
|pr-created=x
|botflag-ok=x
|pr-merged=x
|deployed=x
|notification=x
|tested-real-conditions=x

|wmlang=or
|requester=Psubhashish
|programmer=Pamputt
|botmaster=Poslovitch
}}


  • [x] Request opened.
  • [x] Requirements defined.
  • [x] Script coded.
  • [x] Code submited (Pull Request).
  • [x] Code accepted.
  • [x] Requestee notified.
  • [] Community notified.
  • [] Local help page created.
  • [] 7 days delay.
  • [] Bot activated.

or: add parameter requestee-Poslovitch,Pamputt

Retrieved from "https://lingualibre.org/index.php?title=Template:Bot_steps/Documentation&oldid=666406"