Project

General

Profile

Actions

User story #7592

closed

Complete the technique creation documentation

Added by Alexis Mousset over 8 years ago. Updated about 3 years ago.

Status:
Rejected
Priority:
N/A
Assignee:
-
Category:
Documentation
UX impact:
Suggestion strength:
User visibility:
Effort required:
Name check:
Fix check:
Regression:

Description

In http://www.rudder-project.org/rudder-doc-2.11/rudder-doc.html#_technique_creation, at the end:

Define variables

WORK IN PROGRESS Define metadata. Enter the variables in sections in the metadata.xml file. Cf http://www.rudder-project.org/foswiki/Development/PolicyTemplateXML
First test in the Rudder interface

Load the new Technique into Rudder and check that the variables and sections are displayed as you expect.
Implement the behavior

WORK IN PROGRESS Write CFEngine promises to implement the behavior that your Template should have.
Read in the variables from Rudder

WORK IN PROGRESS Using StringTemplate notation… Cf http://www.rudder-project.org/foswiki/Development/Technique
Add reporting

WORK IN PROGRESS The reports format Cf http://www.rudder-project.org/foswiki/Development/ReportsInTechniques
This does not make sense and looks really bad. Needs to be reworked. We should integrate relevant content from foswiki pages, and explain clearly:
  • how to write a technique, starting with a valid stub technique
  • how to add a new technique to Rudder

Related issues 4 (0 open4 closed)

Is duplicate of Rudder - User story #4202: Update documentation about TechniqueXML with new elements RejectedAlexis Mousset2013-11-29Actions
Is duplicate of Rudder - User story #3218: Blank techniqueRejected2013-01-25Actions
Is duplicate of Rudder - Bug #3959: Add a valid Technique example in documentationRejected2013-09-24Actions
Is duplicate of Rudder - User story #4730: Explain how to add Technique in docsRejectedBenoît PECCATTE2014-04-03Actions
Actions

Also available in: Atom PDF