-
Notifications
You must be signed in to change notification settings - Fork 1
/
profile-registry.html
841 lines (780 loc) · 29 KB
/
profile-registry.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.4" />
<title>ALPS Registry Guidelines</title>
<style type="text/css">
/* Sans-serif font. */
h1, h2, h3, h4, h5, h6,
div.title, caption.title,
thead, p.table.header,
div#toctitle,
span#author, span#revnumber, span#revdate, span#revremark,
div#footer {
font-family: Arial,Helvetica,sans-serif;
}
/* Serif font. */
div.sectionbody {
font-family: Georgia,"Times New Roman",Times,serif;
}
/* Monospace font. */
tt {
font-size: inherit;
}
body {
margin: 1em 5% 1em 5%;
}
a {
color: blue;
text-decoration: underline;
}
a:visited {
color: fuchsia;
}
em {
font-style: italic;
color: navy;
}
strong {
font-weight: bold;
color: #083194;
}
tt {
font-size: inherit;
color: navy;
}
h1, h2, h3, h4, h5, h6 {
color: #527bbd;
margin-top: 1.2em;
margin-bottom: 0.5em;
line-height: 1.3;
}
h1, h2, h3 {
border-bottom: 2px solid silver;
}
h2 {
padding-top: 0.5em;
}
h3 {
float: left;
}
h3 + * {
clear: left;
}
div.sectionbody {
margin-left: 0;
}
hr {
border: 1px solid silver;
}
p {
margin-top: 0.5em;
margin-bottom: 0.5em;
}
ul, ol, li > p {
margin-top: 0;
}
ul > li { color: #aaa; }
ul > li > * { color: black; }
pre {
padding: 0;
margin: 0;
}
span#author {
color: #527bbd;
font-weight: bold;
font-size: 1.1em;
}
span#email {
}
span#revnumber, span#revdate, span#revremark {
}
div#footer {
font-size: small;
border-top: 2px solid silver;
padding-top: 0.5em;
margin-top: 4.0em;
}
div#footer-text {
float: left;
padding-bottom: 0.5em;
}
div#footer-badges {
float: right;
padding-bottom: 0.5em;
}
div#preamble {
margin-top: 1.5em;
margin-bottom: 1.5em;
}
div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
div.admonitionblock {
margin-top: 1.0em;
margin-bottom: 1.5em;
}
div.admonitionblock {
margin-top: 2.0em;
margin-bottom: 2.0em;
margin-right: 10%;
color: #606060;
}
div.content { /* Block element content. */
padding: 0;
}
/* Block element titles. */
div.title, caption.title {
color: #527bbd;
font-weight: bold;
text-align: left;
margin-top: 1.0em;
margin-bottom: 0.5em;
}
div.title + * {
margin-top: 0;
}
td div.title:first-child {
margin-top: 0.0em;
}
div.content div.title:first-child {
margin-top: 0.0em;
}
div.content + div.title {
margin-top: 0.0em;
}
div.sidebarblock > div.content {
background: #ffffee;
border: 1px solid #dddddd;
border-left: 4px solid #f0f0f0;
padding: 0.5em;
}
div.listingblock > div.content {
border: 1px solid #dddddd;
border-left: 5px solid #f0f0f0;
background: #f8f8f8;
padding: 0.5em;
}
div.quoteblock, div.verseblock {
padding-left: 1.0em;
margin-left: 1.0em;
margin-right: 10%;
border-left: 5px solid #f0f0f0;
color: #777777;
}
div.quoteblock > div.attribution {
padding-top: 0.5em;
text-align: right;
}
div.verseblock > pre.content {
font-family: inherit;
font-size: inherit;
}
div.verseblock > div.attribution {
padding-top: 0.75em;
text-align: left;
}
/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
div.verseblock + div.attribution {
text-align: left;
}
div.admonitionblock .icon {
vertical-align: top;
font-size: 1.1em;
font-weight: bold;
text-decoration: underline;
color: #527bbd;
padding-right: 0.5em;
}
div.admonitionblock td.content {
padding-left: 0.5em;
border-left: 3px solid #dddddd;
}
div.exampleblock > div.content {
border-left: 3px solid #dddddd;
padding-left: 0.5em;
}
div.imageblock div.content { padding-left: 0; }
span.image img { border-style: none; }
a.image:visited { color: white; }
dl {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
dt {
margin-top: 0.5em;
margin-bottom: 0;
font-style: normal;
color: navy;
}
dd > *:first-child {
margin-top: 0.1em;
}
ul, ol {
list-style-position: outside;
}
ol.arabic {
list-style-type: decimal;
}
ol.loweralpha {
list-style-type: lower-alpha;
}
ol.upperalpha {
list-style-type: upper-alpha;
}
ol.lowerroman {
list-style-type: lower-roman;
}
ol.upperroman {
list-style-type: upper-roman;
}
div.compact ul, div.compact ol,
div.compact p, div.compact p,
div.compact div, div.compact div {
margin-top: 0.1em;
margin-bottom: 0.1em;
}
div.tableblock > table {
border: 3px solid #527bbd;
}
thead, p.table.header {
font-weight: bold;
color: #527bbd;
}
tfoot {
font-weight: bold;
}
td > div.verse {
white-space: pre;
}
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
div.tableblock > table[frame="hsides"] {
border-left-style: none;
border-right-style: none;
}
div.tableblock > table[frame="vsides"] {
border-top-style: none;
border-bottom-style: none;
}
div.hdlist {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
div.hdlist tr {
padding-bottom: 15px;
}
dt.hdlist1.strong, td.hdlist1.strong {
font-weight: bold;
}
td.hdlist1 {
vertical-align: top;
font-style: normal;
padding-right: 0.8em;
color: navy;
}
td.hdlist2 {
vertical-align: top;
}
div.hdlist.compact tr {
margin: 0;
padding-bottom: 0;
}
.comment {
background: yellow;
}
.footnote, .footnoteref {
font-size: 0.8em;
}
span.footnote, span.footnoteref {
vertical-align: super;
}
#footnotes {
margin: 20px 0 20px 0;
padding: 7px 0 0 0;
}
#footnotes div.footnote {
margin: 0 0 5px 0;
}
#footnotes hr {
border: none;
border-top: 1px solid silver;
height: 1px;
text-align: left;
margin-left: 0;
width: 20%;
min-width: 100px;
}
div.colist td {
padding-right: 0.5em;
padding-bottom: 0.3em;
vertical-align: top;
}
div.colist td img {
margin-top: 0.3em;
}
@media print {
div#footer-badges { display: none; }
}
div#toc {
margin-bottom: 2.5em;
}
div#toctitle {
color: #527bbd;
font-size: 1.1em;
font-weight: bold;
margin-top: 1.0em;
margin-bottom: 0.1em;
}
div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
margin-top: 0;
margin-bottom: 0;
}
div.toclevel2 {
margin-left: 2em;
font-size: 0.9em;
}
div.toclevel3 {
margin-left: 4em;
font-size: 0.9em;
}
div.toclevel4 {
margin-left: 6em;
font-size: 0.9em;
}
span.aqua { color: aqua; }
span.black { color: black; }
span.blue { color: blue; }
span.fuchsia { color: fuchsia; }
span.gray { color: gray; }
span.green { color: green; }
span.lime { color: lime; }
span.maroon { color: maroon; }
span.navy { color: navy; }
span.olive { color: olive; }
span.purple { color: purple; }
span.red { color: red; }
span.silver { color: silver; }
span.teal { color: teal; }
span.white { color: white; }
span.yellow { color: yellow; }
span.aqua-background { background: aqua; }
span.black-background { background: black; }
span.blue-background { background: blue; }
span.fuchsia-background { background: fuchsia; }
span.gray-background { background: gray; }
span.green-background { background: green; }
span.lime-background { background: lime; }
span.maroon-background { background: maroon; }
span.navy-background { background: navy; }
span.olive-background { background: olive; }
span.purple-background { background: purple; }
span.red-background { background: red; }
span.silver-background { background: silver; }
span.teal-background { background: teal; }
span.white-background { background: white; }
span.yellow-background { background: yellow; }
span.big { font-size: 2em; }
span.small { font-size: 0.6em; }
</style>
<script type="text/javascript">
/*<+'])');
// Function that scans the DOM tree for header elements (the DOM2
// nodeIterator API would be a better technique but not supported by all
// browsers).
var iterate = function (el) {
for (var i = el.firstChild; i != null; i = i.nextSibling) {
if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
var mo = re.exec(i.tagName);
if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
}
iterate(i);
}
}
}
iterate(el);
return result;
}
var toc = document.getElementById("toc");
var entries = tocEntries(document.getElementById("content"), toclevels);
for (var i = 0; i < entries.length; ++i) {
var entry = entries[i];
if (entry.element.id == "")
entry.element.id = "_toc_" + i;
var a = document.createElement("a");
a.href = "#" + entry.element.id;
a.appendChild(document.createTextNode(entry.text));
var div = document.createElement("div");
div.appendChild(a);
div.className = "toclevel" + entry.toclevel;
toc.appendChild(div);
}
if (entries.length == 0)
toc.parentNode.removeChild(toc);
},
/////////////////////////////////////////////////////////////////////
// Footnotes generator
/////////////////////////////////////////////////////////////////////
/* Based on footnote generation code from:
* http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
*/
footnotes: function () {
var cont = document.getElementById("content");
var noteholder = document.getElementById("footnotes");
var spans = cont.getElementsByTagName("span");
var refs = {};
var n = 0;
for (i=0; i<spans.length; i++) {
if (spans[i].className == "footnote") {
n++;
// Use [\s\S] in place of . so multi-line matches work.
// Because JavaScript has no s (dotall) regex flag.
note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
noteholder.innerHTML +=
"<div class='footnote' id='_footnote_" + n + "'>" +
"<a href='#_footnoteref_" + n + "' title='Return to text'>" +
n + "</a>. " + note + "</div>";
spans[i].innerHTML =
"[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
"' title='View footnote' class='footnote'>" + n + "</a>]";
var id =spans[i].getAttribute("id");
if (id != null) refs["#"+id] = n;
}
}
if (n == 0)
noteholder.parentNode.removeChild(noteholder);
else {
// Process footnoterefs.
for (i=0; i<spans.length; i++) {
if (spans[i].className == "footnoteref") {
var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
href = href.match(/#.*/)[0]; // Because IE return full URL.
n = refs[href];
spans[i].innerHTML =
"[<a href='#_footnote_" + n +
"' title='View footnote' class='footnote'>" + n + "</a>]";
}
}
}
}
}
/*]]>*/
</script>
</head>
<body class="article">
<div id="header">
<h1>ALPS Registry Guidelines</h1>
<span id="author">Mike Amundsen</span><br />
<span id="email"><tt><<a href="mailto:mca@amundsen.com">mca@amundsen.com</a>></tt></span><br />
<span id="revdate">January 29, 2014</span>
<div id="toc">
<div id="toctitle">Table of Contents</div>
<noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
</div>
</div>
<div id="content">
<div class="sect1">
<h2 id="_summary">Summary</h2>
<div class="sectionbody">
<div class="paragraph"><p>This document describes the ALPS<a href="#0">[0]</a> Registry Guidelines. These guidelines are used to set up and manage the ALPS Public Registry (APR). The APR holds a set of publicly available ALPS profiles along with other related material including registered ALPS Extensions. These guidelines may also be used to establish other ALPS registries.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_background">Background</h2>
<div class="sectionbody">
<div class="paragraph"><p>The goal of ALPS profiles is to provide a "shared understanding" of service descriptions for the Web. To this end, ALPS profile documents describe hypermedia interfaces (data elements and state transitions) that are helpful when implementing a services and when implement client applications that will access services.</p></div>
<div class="paragraph"><p>The goal of ALPS registries is to act as a repository of available ALPS profile descriptions and ALPS extension definitions. When services implement an ALPS profile, they can advertise thier support using the appropriate protocol-level mechanisms (Link headers<a href="#2">[2]</a>, inline links<a href="#3">[3]</a>, media type parameters<a href="#4">[4]</a>, etc.). Client implementations can be programmed to ‘recognize’ and process one or more ALPS profiles. By placing ALPS documents in an available registry, these profiles can be more widely circulated and used as a basis for enabling "serendipitous reuse"<a href="#5">[5]</a>.</p></div>
<div class="sect2">
<h3 id="_promoting_reuse">Promoting Reuse</h3>
<div class="paragraph"><p>One role of ALPS registries is to make it easy to locate and refer to shared ALPS profiles. A robust ecosystem of registries is important to increasing the re-use of ALPS profiles. By creating common locations where ALPS documents can be found and referenced makes it more likely those profiles and extensions will be re-used.</p></div>
</div>
<div class="sect2">
<h3 id="_single_profile_mutliple_use">Single Profile, Mutliple-Use</h3>
<div class="paragraph"><p>An ALPS profile is most useful when is describes a service in a way that supports multiple use. In other words, a description that more than one server can implment without making any changes to the ALPS profile. The more often a single ALPS profile is used in an implementation on the Web, the more valuable that singlie profile becomes.</p></div>
</div>
<div class="sect2">
<h3 id="_distributed_descriptions">Distributed Descriptions</h3>
<div class="paragraph"><p>While profile re-use is important, the ALPS registry model is not meant to enforce a single source for all shared ALPS profiles. These guidelines exist to help anyone who wishes to establish and maintain their own ALPS reigstry for whatever reason (See <a href="#establish-registry">Guidelines for Establishing an ALPS Registry</a> below).</p></div>
<div class="paragraph"><p>There are a number of possible reasons for establishing an ALPS registry:</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
Internal Use
</dt>
<dd>
<p>
It is possible that some organizations will want to establish their own local ALPS registry for internal use. This is especially valuable during the early design and testing phase of profile documents.
</p>
</dd>
<dt class="hdlist1">
Specific Topics
</dt>
<dd>
<p>
It is also possible that, over time, ALPS registries will be created to support a specific topic or area of study (e.g. astronomy, commerce, social networking, etc.).
</p>
</dd>
<dt class="hdlist1">
Performance
</dt>
<dd>
<p>
There may be cases where it makes sense to maintain and ALPS registry in order to reduce network latency or improve performace of the runtime applications.
</p>
</dd>
</dl></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">
<div class="paragraph"><p>It should be noted that the resolvable URL of an ALPS profile or extension (which includes the registry in which is it located) is the unqiue identifier for that particular document. Copying ALPS documents from one registry to another is actually creating a <em>new</em> ALPS document; essentially ‘forking’ the existing document. For this reason, copying ALPS documents into multiple registries is discouraged.</p></div>
</td>
</tr></table>
</div>
<div class="paragraph"><p>For whatever the reason, individuals or organizations are free to establish and maintain there own ALPS registries and are strongly encouraged follow the guidelines spelled out in this document.</p></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_compliance">Compliance</h2>
<div class="sectionbody">
<div class="paragraph"><p>All ALPS Profile Registries should be maintained in a manner that is consistent with the contents of this document. Each hosted APR should be occasionally reviewed and, as needed, modified in order to stay within the guidelines set out in this document.</p></div>
<div class="sect2">
<h3 id="_notational_conventions">Notational Conventions</h3>
<div class="paragraph"><p>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC2119<a href="#1">[1]</a>.</p></div>
</div>
<div class="sect2">
<h3 id="_compliance_criteria">Compliance Criteria</h3>
<div class="paragraph"><p>An ALPS registry is not compliant if it fails to satisfy one or more of the MUST or REQUIRED level requirements. An implementation that satisfies all the MUST or REQUIRED level and all the SHOULD level requirements is said to be "unconditionally compliant"; one that satisfies all the MUST level requirements but not all the SHOULD level requirements is said to be "conditionally compliant." All ALPS Registries SHOULD strive to be "unconditionally compliant" implementations (See <a href="#compliance-review">Compliance Review</a> below).</p></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_general_guidelines">General Guidelines</h2>
<div class="sectionbody">
<div class="paragraph"><p>There are not many constraints on the creation and maintenance of ALPS Profile Registries (APRs). There are, however, some general guidelines (covered below) that should be followed by those who wish to host APRs. They are:</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
Open to All
</dt>
<dd>
<p>
APRs should be open to all. Maintainers should not be ‘gatekeepers’ but should instead be enablers for anyone wishing to contribute
</p>
</dd>
<dt class="hdlist1">
Stable
</dt>
<dd>
<p>
It is important that APRs are stable and reliable services. Application developers will grow to rely on the APRs and they deserve the best possible experience.
</p>
</dd>
<dt class="hdlist1">
Primary Registry
</dt>
<dd>
<p>
This document charters the creation of at least one ‘primary’ APR and a link to that APR SHOULD appear on the ALPS website.
</p>
</dd>
<dt class="hdlist1">
Additional Registries
</dt>
<dd>
<p>
This document can also be used as a guide for creating additional APRs. There are not restrictions on who can create or host an APR.
</p>
</dd>
</dl></div>
<div class="sect2">
<h3 id="_open_to_all">Open to All</h3>
<div class="paragraph"><p>The aim of ALPS Profile Registries (APRs) is to provide a collaborative repository for sharing profile and extension documents. Since a key goal for the ALPS specification<a href="#0">[0]</a> is to increase "shared understanding" between client and service implementors, an open place where ALPS documents can be shared and referenced is important.</p></div>
<div class="paragraph"><p>It is also important that the spirit of APRs is one of mutual support. APRs should not become barriers to those who wish to contribute profiles. Those who lead and maintain APR communities should not act as ‘gatekeepers’ or as blocking factors for those who want to contribute profiles. To quote David Clark<a href="#6">[6]</a>:</p></div>
<div class="quoteblock">
<div class="content">
<div class="paragraph"><p>We reject: kings, presidents and voting.</p></div>
<div class="paragraph"><p>We believe in: rough consensus and running code.<a href="#7">[7]</a></p></div>
</div>
<div class="attribution">
<em>Proceedings of the Twenty-Fourth Internet Engineering Task Force - 1992</em><br />
— David D. Clark
</div></div>
<div class="paragraph"><p>It is also important to remember that registering profiles and extensions in APRs is RECOMMENDED, but NOT REQUIRED. There may base cases where profiles will be used, but not shared. While this is not within the spirit of ALPS in general, that’s OK.</p></div>
</div>
<div class="sect2">
<h3 id="_stable">Stable</h3>
<div class="paragraph"><p>It is also important that APRs are stable, reliable. Those hosting and maintaining profiles and extensions take on the responsibilty to maintain a service that is both available and responsive. APR maintainers should take all necessary steps to keep their service up and running.</p></div>
<div class="paragraph"><p>They should also work to reduce the chance of "breakage" for existing profiles and extensions. That means APRs should make it ‘hard’ for authors to modify registered profiles and extensions in ways that will introduce backware incompatibilities. It is RECOMMENDED that maintainers institute review processes that reduce breakage and encourage profile and extension authors to keep this uppermost in mind when creating and updating their ALPS documents.</p></div>
</div>
<div class="sect2">
<h3 id="_primary_registry">Primary Registry</h3>
<div class="paragraph"><p>This document is a a charter to create at least one ‘primary’ APR to hold as many avaialble profile and extension documents as possible. A link to this primary registry SHOULD appear on the ALPS website (<a href="http://alps.io">http://alps.io</a>). The role of this primary registry is to act as a place where the spirit of ALPS and the guidelines listed here are promoted and protected. It can also act as a place where those interested in learning more about ALPS and find helpful material and an opportunity to participate in the maintenance of the APR.</p></div>
</div>
<div class="sect2">
<h3 id="_additional_registries">Additional Registries</h3>
<div class="paragraph"><p>This document is also meant to be a guide to those who with to start their own ALPS Profile Repositories. There is not limit to the number of APRs that may exist. There are no special qualifications needed for those willing to host a repository and there are not permissions needed in order to do so.</p></div>
<div class="paragraph"><p>However, once an APR is created, those hosting it have a responsbility to continue to maintain it in a responsible and reliable manner. Since it is possible that developers will rely in the APR to serve up ALPS documents in order to keep their applications running properly, APR maintainers have a duty to continue to respond to ALPS document requests well into the future. See <a href="#establish-registry">Guidelines for Establishing An ALPS Registry</a> for details on the proper creation and maintenance of APRs.</p></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_the_alps_profile_registry">The ALPS Profile Registry</h2>
<div class="sectionbody">
<div class="paragraph"><p>[TK intro what a profile is and how it should be handled here.]</p></div>
<div class="sect2">
<h3 id="_adding_alps_documents">Adding ALPS Documents</h3>
<div class="paragraph"><p>[TK describe typical process for adding including data to collect, data to reflect, and support for both XML and JSON representations]</p></div>
<div class="sect3">
<h4 id="_adding_profile_documents">Adding Profile Documents</h4>
<div class="paragraph"><p>[TK describe typical process for adding including data to collect, data to reflect, and support for both XML and JSON representations]</p></div>
</div>
</div>
<div class="sect2">
<h3 id="_adding_extension_documents">Adding Extension Documents</h3>
<div class="paragraph"><p>[TK describe typical process for adding including data to collect, data to reflect, and support for both XML and JSON representations]</p></div>
</div>
<div class="sect2">
<h3 id="_tagging_alps_documents">Tagging ALPS Documents</h3>
<div class="paragraph"><p>[TK encourage use of tagging to categorize profiles. not hierarchy, folksonomies references here.]</p></div>
</div>
<div class="sect2">
<h3 id="_searching_alps_documents">Searching ALPS Documents</h3>
<div class="paragraph"><p>[TK describe ways to search for profiles (tags, titles, doc contents, etc.]</p></div>
</div>
<div class="sect2">
<h3 id="_crawling_for_alps_documents">Crawling for ALPS Documents</h3>
<div class="paragraph"><p>[TK describe possible support for crawlers that might be created to gather ALPS info and publish it in a searchable form. (does this really go here?)]</p></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="establish-registry">Guidelines for Establishing An ALPS Registry</h2>
<div class="sectionbody">
<div class="paragraph"><p>[TK intro into the notion of creating and maintaining an APR.]</p></div>
<div class="sect2">
<h3 id="_announcement">Announcement</h3>
<div class="paragraph"><p>[TK announce on the primary list: https://groups.google.com/forum/?fromgroups=#!forum/alps-io]</p></div>
</div>
<div class="sect2">
<h3 id="compliance-review">Compliance Review</h3>
<div class="paragraph"><p>[TK describe process of requesting review on the primary list, what the review should entail, that reviews are *optional*]</p></div>
</div>
<div class="sect2">
<h3 id="_contacts_and_support">Contacts and Support</h3>
<div class="paragraph"><p>[TK the primary newgroup and the website are sources of general contact and support. Each registry SHOULD also create their own modes of support and post on the registry web site.]</p></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_references">References</h2>
<div class="sectionbody">
<div class="ulist"><ul>
<li>
<p>
<a id="0"></a> 0. Application-Level Profile Semantics <a href="http://alps.io/spec/">http://alps.io/spec/</a>
</p>
</li>
<li>
<p>
<a id="1"></a> 1. RFC2119 Key words for use in RFCs to Indicate Requirement Levels <a href="http://tools.ietf.org/search/rfc2119">http://tools.ietf.org/search/rfc2119</a>
</p>
</li>
<li>
<p>
<a id="2"></a> 2. RFC5988 Web Linking <a href="http://tools.ietf.org/search/rfc5988">http://tools.ietf.org/search/rfc5988</a>
</p>
</li>
<li>
<p>
<a id="3"></a> 3. HTML4 Profile Attribute <a href="http://www.w3.org/TR/html401/struct/global.html#adef-profile">http://www.w3.org/TR/html401/struct/global.html#adef-profile</a>
</p>
</li>
<li>
<p>
<a id="4"></a> 4. JSON-LD profile paramter <a href="http://www.w3.org/TR/json-ld/#application-ld-json">http://www.w3.org/TR/json-ld/#application-ld-json</a>
</p>
</li>
<li>
<p>
<a id="5"></a> 5. Charlton, Stu "Planned and Serendipitous Reuse" <a href="http://www.stucharlton.com/blog/archives/000165.html">http://www.stucharlton.com/blog/archives/000165.html</a>
</p>
</li>
<li>
<p>
<a id="6"></a> 6. Wikipedia, "David D. Clark", <a href="http://en.wikipedia.org/wiki/David_D._Clark">http://en.wikipedia.org/wiki/David_D._Clark</a>
</p>
</li>
<li>
<p>
<a id="7"></a> 7. IETF Proceedings, "Proceedings of the Twenty-Fourth Internet Engineering Task Force" <a href="http://www.ietf.org/old/2009/proceedings/prior29/IETF24.pdf">http://www.ietf.org/old/2009/proceedings/prior29/IETF24.pdf</a>
</p>
</li>
</ul></div>
</div>
</div>
<div class="sect1">
<h2 id="_appendix_a_frequently_asked_queestions">Appendix A : Frequently Asked Queestions</h2>
<div class="sectionbody">
<div class="paragraph"><p>[TK collect stuff here that deserves response, but doesn't rise to a section in the doc]</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_appendix_b_existing_registries">Appendix B : Existing Registries</h2>
<div class="sectionbody">
<div class="paragraph"><p>[TK should we start with this or keep this a live page?]</p></div>
</div>
</div>
</div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Last updated 2014-02-02 13:13:32 EST
</div>
</div>
</body>
</html>