Difference between revisions of "Bot steps/Documentation"

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

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

Steps at creation

request: The requester from an external wiki has posted their request on LinguaLibre:Bot
define: The request is taken into account, any additional information that would be needed for development is asked to the requester.
community-approval: The requester ensures the target wiki's community is aware and willing to use LinguaLibreBot.
account: The botmaster creates the local LinguaLibreBot account on the target wiki.
code: The developer assigned to the request writes the script.
test: The developer assigned to the request tested their script on the target wiki.
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).
pr-created: The developer creates the pull request on GitHub.
botflag-ok: The bot flag for LinguaLibreBot is granted.
pr-merged: Once the code is tested and the bot flag is applied, the botmaster merges the pull request.
deployed: The botmaster deploys the target wiki integration on Toolforge.
notification: The botmaster or the developer notifies the requester and the community of the target wiki that the bot is active.
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
}}

Bot creation's steps

[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

@@ Line 1: / Line 1: @@
 <noinclude><languages /></noinclude><translate><!--T: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.
+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 == <!--T:2-->
@@ Line 7: / Line 7: @@
 # <tvar|wmlang><code>wmlang</code></>: code used by the Wikimedia projects of the target language.
 # <tvar|requester><code>requester</code></>: username of the requester.
-# <tvar|assigned><code>assigned</code></>: username of the developer assigned to the request.
+# <tvar|programmer><code>programmer</code></>: username of the developer assigned to the request.
 # <tvar|botmaster><code>botmaster</code></>: username of the botmaster ([[User:Poslovitch|Poslovitch]] by default).
@@ Line 14: / Line 14: @@
 <!--T:5-->
 # <tvar|request><code>request</code></>: The requester from an external wiki has posted their request on <tvar|1>[[LinguaLibre:Bot]]</>
-# <tvar|discussion><code>discussion</code></>: The request is taken into account, any additional information that would be needed for development is asked to the requester.
+# <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 that the community of the target wiki is aware and willing to use LinguaLibreBot.
+# <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.
@@ Line 33: / Line 33: @@
 |-
 |
+<!-- Notes :
+) these are key hints, descriptors do the clarifications ;
+) move to verbs ?
+) x= the action is "checked, ok, done"
+) an hand of parameters may require their twin `action-url=` parameter. Ex:
+- community-url = url to community discussion
+- botflag-url = url to botflag discussion
+) back up words ideas :
+|ping=x (announce to individual)
+|announce=x
+|submit, submit-code, accept-code=x
+|merge=x
+|notify=
+|help=
+|wait=
+|active=
+-->
 <pre>
-{{Bot cycle
+{{Bot steps
 |request=x
 |define=x
+|community=x
+|account=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
 |wmlang=or
-|requestee=Psubhashish
+|requester=Psubhashish
-|botmaster=Poslovitch,Pamputt
+|programmer=Pamputt
+|botmaster=Poslovitch
 }}</pre>
 |
-{{Bot cycle
+{{Bot steps
 |request=x
 |define=x