Debian Codegraph @

docs/dev/logs/2011-01-24

raw
1 Steven / Nico
2
3 Type:
4 - xml/
5
6 - parameters/
7 - optional_parameters
8 me: too long
9
10 User interested it type:
11
12 - which arguments are available
13 - ls /path/to/type (steven)
14
15 Steven / proposal:
16
17 - manifest/gencode: .meta
18 - attribute directly in dir
19
20 "cdist-help" <type bla>
21
22 - if no direct path
23
24
25 --------------------------------------------------------------------------------
26
27 Doc proposal (Nico):
28
29 man cdist-type-<name>
30
31 Directory structure:
32 "easy to ls -lR and understand what it does"
33
34 ls -lR $(cdist-type-path "typename")/meta/
35
36 ls -lR $(cdist-path type "typename")/meta/
37
38 --------------------------------------------------------------------------------
39
40 What consumes most type?
41
42 - Writing types, because they are functionality
43 - Define attributes
44 - required/optional
45
46 Type documentation
47
48 $type/.meta/required_parameters/path contains
49 "Path in which file is created"
50 --------------------------------------------------------------------------------
51
52
53 Doc of every type:
54
55 - required/optional parameters
56 - description
57
58 --------------------------------------------------------------------------------
59
60 ! Validation of type input:
61
62 Not only required/optional parameters:
63
64 - handling of either content/source arguments
65
66 - validate script in type?
67 - seperate validation from manifest may be senseful
68 --------------------------------------------------------------------------------
69
70 Explorer per type?
71
72 - helpful or evil?
73 - helps to summarise/get information near ressource that needs it
74 - emphasises type specific explorers
75 -> explorer should be reusable by everybody!
76 --------------------------------------------------------------------------------
77 Explorer delivers facts
78
79 - central repo
80 - not being able to override
81
82 - may be helpful to override facts for debugging (i.e. os=redhat)
83 - one explorer returns one fact
84 - facts via environment variables
85 - proposal steven: UPPER_CASE
86 - __fact_os (Nico)
87
88 - DEFINE path_to_explorer
89 - DEFINE explorer
90 --------------------------------------------------------------------------------
91
92