Project

General

Profile

Actions

User story #4730

closed

Explain how to add Technique in docs

Added by William Ott about 10 years ago. Updated over 8 years ago.

Status:
Rejected
Priority:
2
Category:
Documentation
Target version:
UX impact:
Suggestion strength:
User visibility:
Effort required:
Name check:
Fix check:
Regression:

Description

Include: That a new technique must be added to the git repo and that the changes must be commited before it is visible in the web interface.

Neither the docs for the stable release 2.6, nor 2.9 and 2.10 docs mentioned to add a newly created technique to the git repository and commit these changes.
Was wondering why the new technique didn't show up in the web interface, even though i followed the docs. Just came across this solution by browsing through the issues here that contain the keyword 'technique'.
Furthermore no logs revealed anything why it didn't show up and creating the flag file '/opt/rudder/etc/force_technique_reload' didn't help either.

FAR: It could be a sub-chapter of http://www.rudder-project.org/rudder-doc-2.10/rudder-doc.html#_techniques including information from http://www.rudder-project.org/rudder-doc-2.10/rudder-doc.html#_about_technique_upgrades and other important topic like: what are the relevant directories (accounting for ncf), what must be done to add a technique, how it works with ncf-builder, etc. Anything that Rudder does to manage techniques.


Related issues 1 (0 open1 closed)

Has duplicate Rudder - User story #7592: Complete the technique creation documentationRejectedActions
Actions #1

Updated by François ARMAND about 10 years ago

  • Status changed from New to 8
  • Priority changed from N/A to 2
  • Target version set to 2.6.13

Thanks for the report, clearly it's a missing point.

Actions #2

Updated by Vincent MEMBRÉ almost 10 years ago

  • Target version changed from 2.6.13 to 2.6.14
Actions #3

Updated by Jonathan CLARKE almost 10 years ago

  • Target version changed from 2.6.14 to 2.6.16
Actions #4

Updated by Jonathan CLARKE almost 10 years ago

  • Target version changed from 2.6.16 to 2.6.17
Actions #5

Updated by Nicolas PERRON over 9 years ago

  • Target version changed from 2.6.17 to 2.6.18
Actions #6

Updated by Matthieu CERDA over 9 years ago

  • Target version changed from 2.6.18 to 2.6.19
Actions #7

Updated by Vincent MEMBRÉ over 9 years ago

  • Target version changed from 2.6.19 to 2.6.20
Actions #8

Updated by François ARMAND about 9 years ago

  • Subject changed from Update point Technique creation (10.6) in docs to Explain how to add Technique in docs
  • Description updated (diff)
  • Assignee set to Benoît PECCATTE
  • Target version changed from 2.6.20 to 2.10.10

The relevant documentation is http://www.rudder-project.org/rudder-doc-2.10/rudder-doc.html#_about_technique_upgrades but clearly, it merits its own top level chapter.

This is even more true with ncf-builder and its specific workflow.

So we need to rethink the documentation for that.

Benoit, it seems to be the very very first step to rework the Techniques Store maze. So I think it's pertinent that you take that one in charge.

Actions #9

Updated by Vincent MEMBRÉ about 9 years ago

  • Target version changed from 2.10.10 to 2.10.11
Actions #10

Updated by Vincent MEMBRÉ about 9 years ago

  • Target version changed from 2.10.11 to 2.10.12
Actions #11

Updated by Vincent MEMBRÉ about 9 years ago

  • Target version changed from 2.10.12 to 2.10.13
Actions #12

Updated by Benoît PECCATTE about 9 years ago

  • Status changed from 8 to New
Actions #13

Updated by Vincent MEMBRÉ about 9 years ago

  • Target version changed from 2.10.13 to 2.10.14
Actions #14

Updated by Vincent MEMBRÉ almost 9 years ago

  • Target version changed from 2.10.14 to 2.10.15
Actions #15

Updated by Vincent MEMBRÉ almost 9 years ago

  • Target version changed from 2.10.15 to 2.10.16
Actions #16

Updated by Vincent MEMBRÉ over 8 years ago

  • Target version changed from 2.10.16 to 2.10.17
Actions #17

Updated by Vincent MEMBRÉ over 8 years ago

  • Target version changed from 2.10.17 to 2.10.18
Actions #18

Updated by Vincent MEMBRÉ over 8 years ago

  • Target version changed from 2.10.18 to 2.10.19
Actions #19

Updated by Vincent MEMBRÉ over 8 years ago

  • Target version changed from 2.10.19 to 2.10.20
Actions #20

Updated by Vincent MEMBRÉ over 8 years ago

  • Target version changed from 2.10.20 to 277
Actions #21

Updated by Vincent MEMBRÉ over 8 years ago

  • Target version changed from 277 to 2.11.18
Actions #22

Updated by Alexis Mousset over 8 years ago

  • Status changed from New to Rejected
Actions #23

Updated by Alexis Mousset over 8 years ago

  • Has duplicate User story #7592: Complete the technique creation documentation added
Actions

Also available in: Atom PDF