User story #3292: Document the new behaviour of directive field - Rudder - Issue Tracker

Actions

User story #3292

closed

User story #2947: A special textarea-type field should exist for the Techniques that automatically escapes some characters

Document the new behaviour of directive field

Added by Nicolas CHARLES about 11 years ago. Updated about 9 years ago.

Status:

Rejected

Priority:

Assignee:

Jonathan CLARKE

Category:

Documentation

Target version:

2.6.11

Pull Request:

UX impact:

Suggestion strength:

User visibility:

Effort required:

Name check:

Fix check:

Regression:

Description

Based on what has been changed on #3281, we need to document :

how the fields are automatically escaped
how to not have them escaped
complete the technique syntax description

Subtasks 1 (0 open — 1 closed)

Actions

Copy link

Updated by Nicolas CHARLES about 11 years ago

Status changed from New to In progress
Assignee set to Nicolas CHARLES

Actions

Copy link

Updated by Nicolas CHARLES about 11 years ago

Hum, actually there is nothing in the documentation about this topic.
I've edited the wiki ( http://www.rudder-project.org/foswiki/bin/view/Development/TechniqueXML ) to explain the new field and the change of behaviour, and I add a warning in older version of documentation

Actions

Copy link

Updated by Nicolas CHARLES about 11 years ago

Status changed from In progress to Discussion
Assignee changed from Nicolas CHARLES to Jonathan CLARKE

Jon, i'm a bit worried about how to document this.

The reference documentation has a very high level overview of the directive : it only explains it's based on a Technique, and is used in Rules
And nothing else (no multivalued section, priority, etc).
This very light doc fits nicely in the begin of the doc, where concept are introduced, but it lacks a more comprehensive doc.
Would it fit in the Reference Manual ? If so, where ?
Or in the wiki only ?

Actions

Copy link

Updated by Nicolas PERRON about 11 years ago

Target version changed from 2.6.0~beta1 to 2.6.0~rc1

Actions

Copy link

Updated by Matthieu CERDA almost 11 years ago

Target version changed from 2.6.0~rc1 to 2.6.0

Actions

Copy link

Updated by Jonathan CLARKE almost 11 years ago

Target version changed from 2.6.0 to 2.6.1

Actions

Copy link

Updated by Nicolas PERRON almost 11 years ago

Target version changed from 2.6.1 to 2.6.2

Actions

Copy link

Updated by Nicolas PERRON almost 11 years ago

Target version changed from 2.6.2 to 2.6.3

Actions

Copy link

Updated by Nicolas PERRON almost 11 years ago

Its user story issue is released but not this issue ? It looks like this ticket should not be linked to its user story

Actions

Copy link

#10

Updated by Nicolas PERRON almost 11 years ago

Target version changed from 2.6.3 to 2.6.4

Actions

Copy link

#11

Updated by Jonathan CLARKE over 10 years ago

Assignee changed from Jonathan CLARKE to Nicolas CHARLES

Oops, looks like I forgot to answer here... Sorry about that!

Since this is only of interest for users of old versions (with newer versions it just works as expected out of the box, no manual escaping needed), I suggest adding a FAQ entry to the website, including the versions this affects.

Actions

Copy link

#12