rbcli 0.2.12 → 0.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +15 -0
- data/Gemfile.lock +39 -38
- data/docs-src/content/development/changelog.md +16 -1
- data/docs-src/themes/hugo-theme-learn/CHANGELOG.md +74 -2
- data/docs-src/themes/hugo-theme-learn/README.md +42 -5
- data/docs-src/themes/hugo-theme-learn/exampleSite/config.toml +27 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/_index.zh.md +12 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/configuration/_index.en.md +6 -4
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/configuration/_index.fr.md +7 -5
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/installation/_index.en.md +1 -1
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/markdown.en.md +88 -61
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/pages/_index.fr.md +3 -3
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/syntaxhighlight.en.md +89 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/_index.en.md +2 -2
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/notice.en.md +2 -2
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/showcase.en.md +4 -1
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/showcase.fr.md +4 -1
- data/docs-src/themes/hugo-theme-learn/exampleSite/static/fonts/monogramos-webfont.svg +1 -237
- data/docs-src/themes/hugo-theme-learn/exampleSite/static/images/showcase/inteliver_docs.png +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/static/images/showcase/tshark_dev.png +0 -0
- data/docs-src/themes/hugo-theme-learn/i18n/ar.toml +26 -0
- data/docs-src/themes/hugo-theme-learn/i18n/de.toml +26 -0
- data/docs-src/themes/hugo-theme-learn/i18n/hi.toml +26 -0
- data/docs-src/themes/hugo-theme-learn/i18n/ja.toml +26 -0
- data/docs-src/themes/hugo-theme-learn/i18n/ru.toml +26 -0
- data/docs-src/themes/hugo-theme-learn/i18n/zh-cn.toml +26 -0
- data/docs-src/themes/hugo-theme-learn/layouts/_default/list.html +1 -1
- data/docs-src/themes/hugo-theme-learn/layouts/_default/single.html +1 -2
- data/docs-src/themes/hugo-theme-learn/layouts/partials/footer.html +3 -4
- data/docs-src/themes/hugo-theme-learn/layouts/partials/header.html +8 -6
- data/docs-src/themes/hugo-theme-learn/layouts/partials/menu.html +6 -5
- data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/children.html +2 -2
- data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/ref.html +1 -1
- data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/relref.html +1 -1
- data/docs-src/themes/hugo-theme-learn/netlify.toml +1 -2
- data/docs-src/themes/hugo-theme-learn/static/css/theme.css +4 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Inconsolata.svg +1 -359
- data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-Normal-webfont.svg +1 -1019
- data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-UltraLight-webfont.svg +1 -918
- data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_200.svg +1 -332
- data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_300.svg +1 -331
- data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_500.svg +1 -333
- data/docs-src/themes/hugo-theme-learn/static/images/clippy.svg +1 -1
- data/docs-src/themes/hugo-theme-learn/static/js/auto-complete.js +3 -223
- data/docs-src/themes/hugo-theme-learn/static/js/highlight.pack.js +6 -3
- data/docs-src/themes/hugo-theme-learn/static/js/hugo-learn.js +8 -5
- data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-brands-400.svg +1 -1260
- data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-regular-400.svg +1 -471
- data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-solid-900.svg +1 -2763
- data/docs/404.html +8 -8
- data/docs/advanced/automatic_updates/index.html +85 -65
- data/docs/advanced/command_types/index.html +139 -144
- data/docs/advanced/distributed_state_locking/index.html +83 -55
- data/docs/advanced/hooks/index.html +94 -81
- data/docs/advanced/index.html +75 -34
- data/docs/advanced/index.xml +8 -8
- data/docs/advanced/interactive_commands/index.html +90 -66
- data/docs/advanced/logging/index.html +94 -67
- data/docs/advanced/remote_execution/index.html +94 -75
- data/docs/advanced/state_storage/index.html +122 -119
- data/docs/advanced/user_config_files/index.html +94 -71
- data/docs/categories/index.html +82 -30
- data/docs/categories/index.xml +1 -1
- data/docs/css/theme.css +4 -0
- data/docs/development/changelog/index.html +185 -177
- data/docs/development/code_of_conduct/index.html +85 -64
- data/docs/development/contributing/index.html +96 -96
- data/docs/development/index.html +75 -34
- data/docs/development/index.xml +2 -2
- data/docs/development/license/index.html +80 -46
- data/docs/fonts/Inconsolata.svg +1 -359
- data/docs/fonts/Novecentosanswide-Normal-webfont.svg +1 -1019
- data/docs/fonts/Novecentosanswide-UltraLight-webfont.svg +1 -918
- data/docs/fonts/Work_Sans_200.svg +1 -332
- data/docs/fonts/Work_Sans_300.svg +1 -331
- data/docs/fonts/Work_Sans_500.svg +1 -333
- data/docs/images/clippy.svg +1 -1
- data/docs/index.html +112 -61
- data/docs/index.json +24 -24
- data/docs/index.xml +13 -13
- data/docs/js/auto-complete.js +3 -223
- data/docs/js/highlight.pack.js +6 -3
- data/docs/js/hugo-learn.js +8 -5
- data/docs/quick_reference/index.html +126 -159
- data/docs/quick_reference/index.xml +1 -1
- data/docs/sitemap.xml +2 -4
- data/docs/tags/index.html +82 -30
- data/docs/tags/index.xml +1 -1
- data/docs/tutorial/10-getting_started/index.html +87 -66
- data/docs/tutorial/20-project_layout/index.html +126 -116
- data/docs/tutorial/30-your_first_command/index.html +151 -141
- data/docs/tutorial/40-options_parameters_and_arguments/index.html +233 -258
- data/docs/tutorial/50-publishing/index.html +86 -66
- data/docs/tutorial/index.html +75 -34
- data/docs/tutorial/index.xml +4 -4
- data/docs/webfonts/fa-brands-400.svg +1 -1260
- data/docs/webfonts/fa-regular-400.svg +1 -471
- data/docs/webfonts/fa-solid-900.svg +1 -2763
- data/docs/whoami/index.html +76 -46
- data/docs/whoami/index.xml +1 -1
- data/lib/rbcli/configuration/configurate_blocks/me.rb +5 -5
- data/lib/rbcli/util/deprecation_warning.rb +21 -4
- data/lib/rbcli/version.rb +1 -1
- data/rbcli.gemspec +8 -8
- data/skeletons/project/Gemfile +1 -1
- data/skeletons/project/config/general.rb +1 -1
- data/skeletons/project/lib/lib.erb +2 -0
- data/skeletons/project/spec/spec_helper.rb +7 -7
- data/skeletons/project/spec/untitled_spec.rb +6 -6
- data/skeletons/project/untitled.gemspec +28 -26
- metadata +29 -20
- data/docs-src/themes/hugo-theme-learn/static/js/html5shiv-printshiv.min.js +0 -4
@@ -3,7 +3,7 @@
|
|
3
3
|
<head>
|
4
4
|
<meta charset="utf-8">
|
5
5
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
6
|
-
<meta name="generator" content="Hugo 0.
|
6
|
+
<meta name="generator" content="Hugo 0.74.3" />
|
7
7
|
<meta name="description" content="">
|
8
8
|
|
9
9
|
|
@@ -12,20 +12,21 @@
|
|
12
12
|
<title>Code of Conduct :: RBCli Documentation</title>
|
13
13
|
|
14
14
|
|
15
|
-
<link href="/rbcli/css/nucleus.css?
|
16
|
-
<link href="/rbcli/css/fontawesome-all.min.css?
|
17
|
-
<link href="/rbcli/css/hybrid.css?
|
18
|
-
<link href="/rbcli/css/featherlight.min.css?
|
19
|
-
<link href="/rbcli/css/perfect-scrollbar.min.css?
|
20
|
-
<link href="/rbcli/css/auto-complete.css?
|
21
|
-
<link href="/rbcli/css/atom-one-dark-reasonable.css?
|
22
|
-
<link href="/rbcli/css/theme.css?
|
23
|
-
<link href="/rbcli/css/hugo-theme.css?
|
15
|
+
<link href="/rbcli/css/nucleus.css?1596148729" rel="stylesheet">
|
16
|
+
<link href="/rbcli/css/fontawesome-all.min.css?1596148729" rel="stylesheet">
|
17
|
+
<link href="/rbcli/css/hybrid.css?1596148729" rel="stylesheet">
|
18
|
+
<link href="/rbcli/css/featherlight.min.css?1596148729" rel="stylesheet">
|
19
|
+
<link href="/rbcli/css/perfect-scrollbar.min.css?1596148729" rel="stylesheet">
|
20
|
+
<link href="/rbcli/css/auto-complete.css?1596148729" rel="stylesheet">
|
21
|
+
<link href="/rbcli/css/atom-one-dark-reasonable.css?1596148729" rel="stylesheet">
|
22
|
+
<link href="/rbcli/css/theme.css?1596148729" rel="stylesheet">
|
23
|
+
<link href="/rbcli/css/hugo-theme.css?1596148729" rel="stylesheet">
|
24
|
+
|
25
|
+
<link href="/rbcli/css/theme-blue.css?1596148729" rel="stylesheet">
|
24
26
|
|
25
|
-
<link href="/rbcli/css/theme-blue.css?1561087612" rel="stylesheet">
|
26
27
|
|
27
28
|
|
28
|
-
<script src="/rbcli/js/jquery-3.3.1.min.js?
|
29
|
+
<script src="/rbcli/js/jquery-3.3.1.min.js?1596148729"></script>
|
29
30
|
|
30
31
|
<style>
|
31
32
|
:root #header + #content > #left > #rlblock_left{
|
@@ -54,14 +55,14 @@
|
|
54
55
|
<span data-search-clear=""><i class="fas fa-times"></i></span>
|
55
56
|
</div>
|
56
57
|
|
57
|
-
<script type="text/javascript" src="/rbcli/js/lunr.min.js?
|
58
|
-
<script type="text/javascript" src="/rbcli/js/auto-complete.js?
|
58
|
+
<script type="text/javascript" src="/rbcli/js/lunr.min.js?1596148729"></script>
|
59
|
+
<script type="text/javascript" src="/rbcli/js/auto-complete.js?1596148729"></script>
|
59
60
|
<script type="text/javascript">
|
60
61
|
|
61
62
|
var baseurl = "https:\/\/akhoury6.github.io\/rbcli\/";
|
62
63
|
|
63
64
|
</script>
|
64
|
-
<script type="text/javascript" src="/rbcli/js/search.js?
|
65
|
+
<script type="text/javascript" src="/rbcli/js/search.js?1596148729"></script>
|
65
66
|
|
66
67
|
|
67
68
|
</div>
|
@@ -74,6 +75,8 @@
|
|
74
75
|
|
75
76
|
|
76
77
|
|
78
|
+
|
79
|
+
|
77
80
|
|
78
81
|
|
79
82
|
|
@@ -96,6 +99,8 @@
|
|
96
99
|
|
97
100
|
|
98
101
|
|
102
|
+
|
103
|
+
|
99
104
|
|
100
105
|
|
101
106
|
|
@@ -121,6 +126,8 @@
|
|
121
126
|
|
122
127
|
|
123
128
|
|
129
|
+
|
130
|
+
|
124
131
|
|
125
132
|
|
126
133
|
|
@@ -140,6 +147,8 @@
|
|
140
147
|
|
141
148
|
|
142
149
|
|
150
|
+
|
151
|
+
|
143
152
|
|
144
153
|
|
145
154
|
|
@@ -159,6 +168,8 @@
|
|
159
168
|
|
160
169
|
|
161
170
|
|
171
|
+
|
172
|
+
|
162
173
|
|
163
174
|
|
164
175
|
|
@@ -178,6 +189,8 @@
|
|
178
189
|
|
179
190
|
|
180
191
|
|
192
|
+
|
193
|
+
|
181
194
|
|
182
195
|
|
183
196
|
|
@@ -197,6 +210,8 @@
|
|
197
210
|
|
198
211
|
|
199
212
|
|
213
|
+
|
214
|
+
|
200
215
|
|
201
216
|
|
202
217
|
|
@@ -223,6 +238,8 @@
|
|
223
238
|
|
224
239
|
|
225
240
|
|
241
|
+
|
242
|
+
|
226
243
|
|
227
244
|
|
228
245
|
|
@@ -248,6 +265,8 @@
|
|
248
265
|
|
249
266
|
|
250
267
|
|
268
|
+
|
269
|
+
|
251
270
|
|
252
271
|
|
253
272
|
|
@@ -267,6 +286,8 @@
|
|
267
286
|
|
268
287
|
|
269
288
|
|
289
|
+
|
290
|
+
|
270
291
|
|
271
292
|
|
272
293
|
|
@@ -286,6 +307,8 @@
|
|
286
307
|
|
287
308
|
|
288
309
|
|
310
|
+
|
311
|
+
|
289
312
|
|
290
313
|
|
291
314
|
|
@@ -305,6 +328,8 @@
|
|
305
328
|
|
306
329
|
|
307
330
|
|
331
|
+
|
332
|
+
|
308
333
|
|
309
334
|
|
310
335
|
|
@@ -324,6 +349,8 @@
|
|
324
349
|
|
325
350
|
|
326
351
|
|
352
|
+
|
353
|
+
|
327
354
|
|
328
355
|
|
329
356
|
|
@@ -343,6 +370,8 @@
|
|
343
370
|
|
344
371
|
|
345
372
|
|
373
|
+
|
374
|
+
|
346
375
|
|
347
376
|
|
348
377
|
|
@@ -362,6 +391,8 @@
|
|
362
391
|
|
363
392
|
|
364
393
|
|
394
|
+
|
395
|
+
|
365
396
|
|
366
397
|
|
367
398
|
|
@@ -381,6 +412,8 @@
|
|
381
412
|
|
382
413
|
|
383
414
|
|
415
|
+
|
416
|
+
|
384
417
|
|
385
418
|
|
386
419
|
|
@@ -400,6 +433,8 @@
|
|
400
433
|
|
401
434
|
|
402
435
|
|
436
|
+
|
437
|
+
|
403
438
|
|
404
439
|
|
405
440
|
|
@@ -426,6 +461,8 @@
|
|
426
461
|
|
427
462
|
|
428
463
|
|
464
|
+
|
465
|
+
|
429
466
|
|
430
467
|
|
431
468
|
|
@@ -451,6 +488,8 @@
|
|
451
488
|
|
452
489
|
|
453
490
|
|
491
|
+
|
492
|
+
|
454
493
|
|
455
494
|
|
456
495
|
|
@@ -470,6 +509,8 @@
|
|
470
509
|
|
471
510
|
|
472
511
|
|
512
|
+
|
513
|
+
|
473
514
|
|
474
515
|
|
475
516
|
|
@@ -489,6 +530,8 @@
|
|
489
530
|
|
490
531
|
|
491
532
|
|
533
|
+
|
534
|
+
|
492
535
|
|
493
536
|
|
494
537
|
|
@@ -508,6 +551,8 @@
|
|
508
551
|
|
509
552
|
|
510
553
|
|
554
|
+
|
555
|
+
|
511
556
|
|
512
557
|
|
513
558
|
|
@@ -534,6 +579,8 @@
|
|
534
579
|
|
535
580
|
|
536
581
|
|
582
|
+
|
583
|
+
|
537
584
|
|
538
585
|
|
539
586
|
|
@@ -585,7 +632,6 @@
|
|
585
632
|
|
586
633
|
|
587
634
|
|
588
|
-
|
589
635
|
<section id="body">
|
590
636
|
<div id="overlay"></div>
|
591
637
|
<div class="padding highlightable">
|
@@ -619,9 +665,9 @@
|
|
619
665
|
|
620
666
|
<a href='/rbcli/'></a> > <a href='/rbcli/development/'>Development</a> > Code of Conduct
|
621
667
|
|
622
|
-
|
668
|
+
|
623
669
|
|
624
|
-
|
670
|
+
|
625
671
|
|
626
672
|
|
627
673
|
|
@@ -631,17 +677,14 @@
|
|
631
677
|
<div class="progress">
|
632
678
|
<div class="wrapper">
|
633
679
|
<nav id="TableOfContents">
|
634
|
-
<ul>
|
635
|
-
<li>
|
636
|
-
<
|
637
|
-
<li><a href="#our-
|
638
|
-
<li><a href="#
|
639
|
-
<li><a href="#
|
640
|
-
<li><a href="#
|
641
|
-
|
642
|
-
<li><a href="#attribution">Attribution</a></li>
|
643
|
-
</ul></li>
|
644
|
-
</ul>
|
680
|
+
<ul>
|
681
|
+
<li><a href="#our-pledge">Our Pledge</a></li>
|
682
|
+
<li><a href="#our-standards">Our Standards</a></li>
|
683
|
+
<li><a href="#our-responsibilities">Our Responsibilities</a></li>
|
684
|
+
<li><a href="#scope">Scope</a></li>
|
685
|
+
<li><a href="#enforcement">Enforcement</a></li>
|
686
|
+
<li><a href="#attribution">Attribution</a></li>
|
687
|
+
</ul>
|
645
688
|
</nav>
|
646
689
|
</div>
|
647
690
|
</div>
|
@@ -665,25 +708,17 @@
|
|
665
708
|
|
666
709
|
|
667
710
|
|
668
|
-
|
669
|
-
|
670
|
-
|
671
711
|
<p><strong>The Contributor Covenant Code of Conduct</strong></p>
|
672
|
-
|
673
712
|
<h2 id="our-pledge">Our Pledge</h2>
|
674
|
-
|
675
713
|
<p>In the interest of fostering an open and welcoming environment, we as
|
676
714
|
contributors and maintainers pledge to making participation in our project and
|
677
715
|
our community a harassment-free experience for everyone, regardless of age, body
|
678
716
|
size, disability, ethnicity, gender identity and expression, level of experience,
|
679
717
|
nationality, personal appearance, race, religion, or sexual identity and
|
680
718
|
orientation.</p>
|
681
|
-
|
682
719
|
<h2 id="our-standards">Our Standards</h2>
|
683
|
-
|
684
720
|
<p>Examples of behavior that contributes to creating a positive environment
|
685
721
|
include:</p>
|
686
|
-
|
687
722
|
<ul>
|
688
723
|
<li>Using welcoming and inclusive language</li>
|
689
724
|
<li>Being respectful of differing viewpoints and experiences</li>
|
@@ -691,9 +726,7 @@ include:</p>
|
|
691
726
|
<li>Focusing on what is best for the community</li>
|
692
727
|
<li>Showing empathy towards other community members</li>
|
693
728
|
</ul>
|
694
|
-
|
695
729
|
<p>Examples of unacceptable behavior by participants include:</p>
|
696
|
-
|
697
730
|
<ul>
|
698
731
|
<li>The use of sexualized language or imagery and unwelcome sexual attention or
|
699
732
|
advances</li>
|
@@ -704,52 +737,41 @@ address, without explicit permission</li>
|
|
704
737
|
<li>Other conduct which could reasonably be considered inappropriate in a
|
705
738
|
professional setting</li>
|
706
739
|
</ul>
|
707
|
-
|
708
740
|
<h2 id="our-responsibilities">Our Responsibilities</h2>
|
709
|
-
|
710
741
|
<p>Project maintainers are responsible for clarifying the standards of acceptable
|
711
742
|
behavior and are expected to take appropriate and fair corrective action in
|
712
743
|
response to any instances of unacceptable behavior.</p>
|
713
|
-
|
714
744
|
<p>Project maintainers have the right and responsibility to remove, edit, or
|
715
745
|
reject comments, commits, code, wiki edits, issues, and other contributions
|
716
746
|
that are not aligned to this Code of Conduct, or to ban temporarily or
|
717
747
|
permanently any contributor for other behaviors that they deem inappropriate,
|
718
748
|
threatening, offensive, or harmful.</p>
|
719
|
-
|
720
749
|
<h2 id="scope">Scope</h2>
|
721
|
-
|
722
750
|
<p>This Code of Conduct applies both within project spaces and in public spaces
|
723
751
|
when an individual is representing the project or its community. Examples of
|
724
752
|
representing a project or community include using an official project e-mail
|
725
753
|
address, posting via an official social media account, or acting as an appointed
|
726
754
|
representative at an online or offline event. Representation of a project may be
|
727
755
|
further defined and clarified by project maintainers.</p>
|
728
|
-
|
729
756
|
<h2 id="enforcement">Enforcement</h2>
|
730
|
-
|
731
757
|
<p>Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
732
|
-
reported by contacting the project team at andrew@blacknex.us. All
|
758
|
+
reported by contacting the project team at <a href="mailto:andrew@blacknex.us">andrew@blacknex.us</a>. All
|
733
759
|
complaints will be reviewed and investigated and will result in a response that
|
734
760
|
is deemed necessary and appropriate to the circumstances. The project team is
|
735
761
|
obligated to maintain confidentiality with regard to the reporter of an incident.
|
736
762
|
Further details of specific enforcement policies may be posted separately.</p>
|
737
|
-
|
738
763
|
<p>Project maintainers who do not follow or enforce the Code of Conduct in good
|
739
764
|
faith may face temporary or permanent repercussions as determined by other
|
740
765
|
members of the project’s leadership.</p>
|
741
|
-
|
742
766
|
<h2 id="attribution">Attribution</h2>
|
743
|
-
|
744
767
|
<p>This Code of Conduct is adapted from the <a href="http://contributor-covenant.org">Contributor Covenant</a>, version 1.4,
|
745
768
|
available at <a href="http://contributor-covenant.org/version/1/4/">http://contributor-covenant.org/version/1/4</a></p>
|
746
769
|
|
747
770
|
|
748
|
-
<footer class="
|
771
|
+
<footer class="footline">
|
749
772
|
|
750
773
|
</footer>
|
751
774
|
|
752
|
-
|
753
775
|
|
754
776
|
</div>
|
755
777
|
|
@@ -1177,20 +1199,19 @@ available at <a href="http://contributor-covenant.org/version/1/4/">http://contr
|
|
1177
1199
|
<div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
|
1178
1200
|
<div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
|
1179
1201
|
</div>
|
1180
|
-
<script src="/rbcli/js/clipboard.min.js?
|
1181
|
-
<script src="/rbcli/js/perfect-scrollbar.min.js?
|
1182
|
-
<script src="/rbcli/js/perfect-scrollbar.jquery.min.js?
|
1183
|
-
<script src="/rbcli/js/jquery.sticky.js?
|
1184
|
-
<script src="/rbcli/js/featherlight.min.js?
|
1185
|
-
<script src="/rbcli/js/
|
1186
|
-
<script src="/rbcli/js/highlight.pack.js?1561087612"></script>
|
1202
|
+
<script src="/rbcli/js/clipboard.min.js?1596148729"></script>
|
1203
|
+
<script src="/rbcli/js/perfect-scrollbar.min.js?1596148729"></script>
|
1204
|
+
<script src="/rbcli/js/perfect-scrollbar.jquery.min.js?1596148729"></script>
|
1205
|
+
<script src="/rbcli/js/jquery.sticky.js?1596148729"></script>
|
1206
|
+
<script src="/rbcli/js/featherlight.min.js?1596148729"></script>
|
1207
|
+
<script src="/rbcli/js/highlight.pack.js?1596148729"></script>
|
1187
1208
|
<script>hljs.initHighlightingOnLoad();</script>
|
1188
|
-
<script src="/rbcli/js/modernizr.custom-3.6.0.js?
|
1189
|
-
<script src="/rbcli/js/learn.js?
|
1190
|
-
<script src="/rbcli/js/hugo-learn.js?
|
1209
|
+
<script src="/rbcli/js/modernizr.custom-3.6.0.js?1596148729"></script>
|
1210
|
+
<script src="/rbcli/js/learn.js?1596148729"></script>
|
1211
|
+
<script src="/rbcli/js/hugo-learn.js?1596148729"></script>
|
1191
1212
|
|
1192
|
-
<link href="/rbcli/mermaid/mermaid.css?
|
1193
|
-
<script src="/rbcli/mermaid/mermaid.js?
|
1213
|
+
<link href="/rbcli/mermaid/mermaid.css?1596148729" rel="stylesheet" />
|
1214
|
+
<script src="/rbcli/mermaid/mermaid.js?1596148729"></script>
|
1194
1215
|
<script>
|
1195
1216
|
mermaid.initialize({ startOnLoad: true });
|
1196
1217
|
</script>
|
@@ -3,7 +3,7 @@
|
|
3
3
|
<head>
|
4
4
|
<meta charset="utf-8">
|
5
5
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
6
|
-
<meta name="generator" content="Hugo 0.
|
6
|
+
<meta name="generator" content="Hugo 0.74.3" />
|
7
7
|
<meta name="description" content="">
|
8
8
|
|
9
9
|
|
@@ -12,20 +12,21 @@
|
|
12
12
|
<title>Contribution Guide :: RBCli Documentation</title>
|
13
13
|
|
14
14
|
|
15
|
-
<link href="/rbcli/css/nucleus.css?
|
16
|
-
<link href="/rbcli/css/fontawesome-all.min.css?
|
17
|
-
<link href="/rbcli/css/hybrid.css?
|
18
|
-
<link href="/rbcli/css/featherlight.min.css?
|
19
|
-
<link href="/rbcli/css/perfect-scrollbar.min.css?
|
20
|
-
<link href="/rbcli/css/auto-complete.css?
|
21
|
-
<link href="/rbcli/css/atom-one-dark-reasonable.css?
|
22
|
-
<link href="/rbcli/css/theme.css?
|
23
|
-
<link href="/rbcli/css/hugo-theme.css?
|
15
|
+
<link href="/rbcli/css/nucleus.css?1596148729" rel="stylesheet">
|
16
|
+
<link href="/rbcli/css/fontawesome-all.min.css?1596148729" rel="stylesheet">
|
17
|
+
<link href="/rbcli/css/hybrid.css?1596148729" rel="stylesheet">
|
18
|
+
<link href="/rbcli/css/featherlight.min.css?1596148729" rel="stylesheet">
|
19
|
+
<link href="/rbcli/css/perfect-scrollbar.min.css?1596148729" rel="stylesheet">
|
20
|
+
<link href="/rbcli/css/auto-complete.css?1596148729" rel="stylesheet">
|
21
|
+
<link href="/rbcli/css/atom-one-dark-reasonable.css?1596148729" rel="stylesheet">
|
22
|
+
<link href="/rbcli/css/theme.css?1596148729" rel="stylesheet">
|
23
|
+
<link href="/rbcli/css/hugo-theme.css?1596148729" rel="stylesheet">
|
24
|
+
|
25
|
+
<link href="/rbcli/css/theme-blue.css?1596148729" rel="stylesheet">
|
24
26
|
|
25
|
-
<link href="/rbcli/css/theme-blue.css?1561087612" rel="stylesheet">
|
26
27
|
|
27
28
|
|
28
|
-
<script src="/rbcli/js/jquery-3.3.1.min.js?
|
29
|
+
<script src="/rbcli/js/jquery-3.3.1.min.js?1596148729"></script>
|
29
30
|
|
30
31
|
<style>
|
31
32
|
:root #header + #content > #left > #rlblock_left{
|
@@ -54,14 +55,14 @@
|
|
54
55
|
<span data-search-clear=""><i class="fas fa-times"></i></span>
|
55
56
|
</div>
|
56
57
|
|
57
|
-
<script type="text/javascript" src="/rbcli/js/lunr.min.js?
|
58
|
-
<script type="text/javascript" src="/rbcli/js/auto-complete.js?
|
58
|
+
<script type="text/javascript" src="/rbcli/js/lunr.min.js?1596148729"></script>
|
59
|
+
<script type="text/javascript" src="/rbcli/js/auto-complete.js?1596148729"></script>
|
59
60
|
<script type="text/javascript">
|
60
61
|
|
61
62
|
var baseurl = "https:\/\/akhoury6.github.io\/rbcli\/";
|
62
63
|
|
63
64
|
</script>
|
64
|
-
<script type="text/javascript" src="/rbcli/js/search.js?
|
65
|
+
<script type="text/javascript" src="/rbcli/js/search.js?1596148729"></script>
|
65
66
|
|
66
67
|
|
67
68
|
</div>
|
@@ -74,6 +75,8 @@
|
|
74
75
|
|
75
76
|
|
76
77
|
|
78
|
+
|
79
|
+
|
77
80
|
|
78
81
|
|
79
82
|
|
@@ -96,6 +99,8 @@
|
|
96
99
|
|
97
100
|
|
98
101
|
|
102
|
+
|
103
|
+
|
99
104
|
|
100
105
|
|
101
106
|
|
@@ -121,6 +126,8 @@
|
|
121
126
|
|
122
127
|
|
123
128
|
|
129
|
+
|
130
|
+
|
124
131
|
|
125
132
|
|
126
133
|
|
@@ -140,6 +147,8 @@
|
|
140
147
|
|
141
148
|
|
142
149
|
|
150
|
+
|
151
|
+
|
143
152
|
|
144
153
|
|
145
154
|
|
@@ -159,6 +168,8 @@
|
|
159
168
|
|
160
169
|
|
161
170
|
|
171
|
+
|
172
|
+
|
162
173
|
|
163
174
|
|
164
175
|
|
@@ -178,6 +189,8 @@
|
|
178
189
|
|
179
190
|
|
180
191
|
|
192
|
+
|
193
|
+
|
181
194
|
|
182
195
|
|
183
196
|
|
@@ -197,6 +210,8 @@
|
|
197
210
|
|
198
211
|
|
199
212
|
|
213
|
+
|
214
|
+
|
200
215
|
|
201
216
|
|
202
217
|
|
@@ -223,6 +238,8 @@
|
|
223
238
|
|
224
239
|
|
225
240
|
|
241
|
+
|
242
|
+
|
226
243
|
|
227
244
|
|
228
245
|
|
@@ -248,6 +265,8 @@
|
|
248
265
|
|
249
266
|
|
250
267
|
|
268
|
+
|
269
|
+
|
251
270
|
|
252
271
|
|
253
272
|
|
@@ -267,6 +286,8 @@
|
|
267
286
|
|
268
287
|
|
269
288
|
|
289
|
+
|
290
|
+
|
270
291
|
|
271
292
|
|
272
293
|
|
@@ -286,6 +307,8 @@
|
|
286
307
|
|
287
308
|
|
288
309
|
|
310
|
+
|
311
|
+
|
289
312
|
|
290
313
|
|
291
314
|
|
@@ -305,6 +328,8 @@
|
|
305
328
|
|
306
329
|
|
307
330
|
|
331
|
+
|
332
|
+
|
308
333
|
|
309
334
|
|
310
335
|
|
@@ -324,6 +349,8 @@
|
|
324
349
|
|
325
350
|
|
326
351
|
|
352
|
+
|
353
|
+
|
327
354
|
|
328
355
|
|
329
356
|
|
@@ -343,6 +370,8 @@
|
|
343
370
|
|
344
371
|
|
345
372
|
|
373
|
+
|
374
|
+
|
346
375
|
|
347
376
|
|
348
377
|
|
@@ -362,6 +391,8 @@
|
|
362
391
|
|
363
392
|
|
364
393
|
|
394
|
+
|
395
|
+
|
365
396
|
|
366
397
|
|
367
398
|
|
@@ -381,6 +412,8 @@
|
|
381
412
|
|
382
413
|
|
383
414
|
|
415
|
+
|
416
|
+
|
384
417
|
|
385
418
|
|
386
419
|
|
@@ -400,6 +433,8 @@
|
|
400
433
|
|
401
434
|
|
402
435
|
|
436
|
+
|
437
|
+
|
403
438
|
|
404
439
|
|
405
440
|
|
@@ -426,6 +461,8 @@
|
|
426
461
|
|
427
462
|
|
428
463
|
|
464
|
+
|
465
|
+
|
429
466
|
|
430
467
|
|
431
468
|
|
@@ -451,6 +488,8 @@
|
|
451
488
|
|
452
489
|
|
453
490
|
|
491
|
+
|
492
|
+
|
454
493
|
|
455
494
|
|
456
495
|
|
@@ -470,6 +509,8 @@
|
|
470
509
|
|
471
510
|
|
472
511
|
|
512
|
+
|
513
|
+
|
473
514
|
|
474
515
|
|
475
516
|
|
@@ -489,6 +530,8 @@
|
|
489
530
|
|
490
531
|
|
491
532
|
|
533
|
+
|
534
|
+
|
492
535
|
|
493
536
|
|
494
537
|
|
@@ -508,6 +551,8 @@
|
|
508
551
|
|
509
552
|
|
510
553
|
|
554
|
+
|
555
|
+
|
511
556
|
|
512
557
|
|
513
558
|
|
@@ -534,6 +579,8 @@
|
|
534
579
|
|
535
580
|
|
536
581
|
|
582
|
+
|
583
|
+
|
537
584
|
|
538
585
|
|
539
586
|
|
@@ -585,7 +632,6 @@
|
|
585
632
|
|
586
633
|
|
587
634
|
|
588
|
-
|
589
635
|
<section id="body">
|
590
636
|
<div id="overlay"></div>
|
591
637
|
<div class="padding highlightable">
|
@@ -619,9 +665,9 @@
|
|
619
665
|
|
620
666
|
<a href='/rbcli/'></a> > <a href='/rbcli/development/'>Development</a> > Contribution Guide
|
621
667
|
|
622
|
-
|
668
|
+
|
623
669
|
|
624
|
-
|
670
|
+
|
625
671
|
|
626
672
|
|
627
673
|
|
@@ -631,16 +677,11 @@
|
|
631
677
|
<div class="progress">
|
632
678
|
<div class="wrapper">
|
633
679
|
<nav id="TableOfContents">
|
634
|
-
<ul>
|
635
|
-
<li><a href="#
|
636
|
-
<li><a href="#
|
637
|
-
<
|
638
|
-
|
639
|
-
<li><a href="#documentation-for-user-features">Documentation for User Features</a></li>
|
640
|
-
<li><a href="#deprecations">Deprecations</a></li>
|
641
|
-
</ul></li>
|
642
|
-
<li><a href="#maintainer-s-notes">Maintainer’s Notes</a></li>
|
643
|
-
</ul>
|
680
|
+
<ul>
|
681
|
+
<li><a href="#tabs-not-spaces">Tabs, Not Spaces</a></li>
|
682
|
+
<li><a href="#documentation-for-user-features">Documentation for User Features</a></li>
|
683
|
+
<li><a href="#deprecations">Deprecations</a></li>
|
684
|
+
</ul>
|
644
685
|
</nav>
|
645
686
|
</div>
|
646
687
|
</div>
|
@@ -664,81 +705,42 @@
|
|
664
705
|
|
665
706
|
|
666
707
|
|
667
|
-
|
668
|
-
|
669
|
-
|
670
708
|
<p>Contributing to RBCli is the same as most open source projects:</p>
|
671
|
-
|
672
709
|
<ol>
|
673
710
|
<li>Fork the repository</li>
|
674
711
|
<li>Create your own branch</li>
|
675
712
|
<li>Submit a pull request when ready</li>
|
676
713
|
</ol>
|
677
|
-
|
678
714
|
<p>That’s all there is to it! We’ve also kept our acceptance criteria pretty simple, as you’ll see below. Feel free to submit a pull request even if you don’t meet it if you would like your code or feature to be reviewed first; we do want to be mindful of your time and will review submissions before they are polished.</p>
|
679
|
-
|
680
715
|
<h1 id="develpment-mode">Develpment Mode</h1>
|
681
|
-
|
682
716
|
<p>To allow for easy deveopment, Rbcli has a development mode which allows a project to include rbcli from a local folder instead of the default gem path. To use it, add the following to your shell’s profile (typically <code>~/.bash_profile</code> or <code>~/.profile</code>):</p>
|
683
|
-
|
684
|
-
<
|
685
|
-
|
686
|
-
|
687
|
-
</code></pre>
|
688
|
-
|
689
|
-
<h1 id="code-acceptance-criteria">Code Acceptance Criteria</h1>
|
690
|
-
|
717
|
+
<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">export RBCLI_ENV<span style="color:#f92672">=</span><span style="color:#e6db74">'development'</span>
|
718
|
+
export RBCLI_DEVPATH<span style="color:#f92672">=</span><span style="color:#e6db74">'/path/to/rbcli/lib/rbcli'</span>
|
719
|
+
alias rbcli<span style="color:#f92672">=</span><span style="color:#e6db74">'/path/to/rbcli/exe/rbcli'</span>
|
720
|
+
</code></pre></div><h1 id="code-acceptance-criteria">Code Acceptance Criteria</h1>
|
691
721
|
<h2 id="tabs-not-spaces">Tabs, Not Spaces</h2>
|
692
|
-
|
693
722
|
<p>Please, and thanks. We all like to use different indentation levels and styles, and this will keep us consistent between editors.</p>
|
694
|
-
|
695
723
|
<p>For filetypes where tabs are not supported (such as YAML), please stick to using two (2) spaces.</p>
|
696
|
-
|
697
724
|
<h2 id="documentation-for-user-features">Documentation for User Features</h2>
|
698
|
-
|
699
725
|
<p>For any modification that alters the way RBCli is used – we’re talking additional features, options, keyword changes, major behavioral changes, and the like – the documentation will need to be updated as well. You’ll be happy to know we designed it to make the process relatively painless.</p>
|
700
|
-
|
701
726
|
<p>RBCli’s documentation is essentially a collection of markdown files that have been compiled into a static site using <a href="https://www.mkdocs.org">MkDocs</a>. If you already have python and pip on your system, you can install it by running:</p>
|
702
|
-
|
703
|
-
|
704
|
-
|
705
|
-
|
706
|
-
<p>You can find the source markdown files in the <code>docs-src/docs</code> folder, and the menu organization in <code>docs-src/mkdocs.yml</code>. To preview your changes on a live site, run:</p>
|
707
|
-
|
708
|
-
<pre><code class="language-bash">mkdocs serve
|
709
|
-
</code></pre>
|
710
|
-
|
711
|
-
<p>Also, don’t forget to update the <strong>Quick Reference Guide</strong> in the <code>README.md</code> file (the main project one) with information about your changes.</p>
|
712
|
-
|
727
|
+
<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">pip install mkdocs mkdocs-material
|
728
|
+
</code></pre></div><p>You can find the source markdown files in the <code>docs-src/docs</code> folder, and the menu organization in <code>docs-src/mkdocs.yml</code>. To preview your changes on a live site, run:</p>
|
729
|
+
<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">mkdocs serve
|
730
|
+
</code></pre></div><p>Also, don’t forget to update the <strong>Quick Reference Guide</strong> in the <code>README.md</code> file (the main project one) with information about your changes.</p>
|
713
731
|
<p>Once you’ve completed your edits, run the <code>makesite.sh</code> command to build the actual HTML pages automatically in the <code>docs</code> folder, from where they will be served when live.</p>
|
714
|
-
|
715
732
|
<h2 id="deprecations">Deprecations</h2>
|
716
|
-
|
717
733
|
<p>If a feature needs to be deprecated, RBCli has a built-in deprecation message feature. You can leverage it by calling the following code when a deprecated command is called:</p>
|
718
|
-
|
719
|
-
|
720
|
-
|
721
|
-
|
722
|
-
<
|
723
|
-
|
724
|
-
<pre><code class="language-ruby">Rbcli::DeprecationWarning.new 'Rbcli::Configurate.me--first_run', 'Please use `RBCli::Configurate.hooks` as the parent block instead.', '0.3.0'
|
725
|
-
</code></pre>
|
726
|
-
|
727
|
-
<p>will display the following message to the user, in red, any any time the application is run:</p>
|
728
|
-
|
729
|
-
<pre><code class="language-text">DEPRECATION WRNING: The feature `Rbcli::Configurate.me--post_hook` has been deprecated. Please use `RBCli::Configurate.hooks` as the parent block instead. This feature will be removed in version 0.3.0.
|
730
|
-
</code></pre>
|
731
|
-
|
732
|
-
<p>Additionally, it will place the same line in the logs using <code>Rbcli.logger.warn</code> if logging is enabled.</p>
|
733
|
-
|
734
|
+
<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-ruby" data-lang="ruby"><span style="color:#66d9ef">Rbcli</span><span style="color:#f92672">::</span><span style="color:#66d9ef">DeprecationWarning</span><span style="color:#f92672">.</span>new deprecated_command, message, version_when_code_will_be_removed
|
735
|
+
</code></pre></div><p>So, for example:</p>
|
736
|
+
<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-ruby" data-lang="ruby"><span style="color:#66d9ef">Rbcli</span><span style="color:#f92672">::</span><span style="color:#66d9ef">DeprecationWarning</span><span style="color:#f92672">.</span>new <span style="color:#e6db74">'Rbcli::Configurate.me--first_run'</span>, <span style="color:#e6db74">'Please use `RBCli::Configurate.hooks` as the parent block instead.'</span>, <span style="color:#e6db74">'0.3.0'</span>
|
737
|
+
</code></pre></div><p>will display the following message to the user, in red, any any time the application is run:</p>
|
738
|
+
<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-text" data-lang="text">DEPRECATION WRNING: The feature `Rbcli::Configurate.me--post_hook` has been deprecated. Please use `RBCli::Configurate.hooks` as the parent block instead. This feature will be removed in version 0.3.0.
|
739
|
+
</code></pre></div><p>Additionally, it will place the same line in the logs using <code>Rbcli.logger.warn</code> if logging is enabled.</p>
|
734
740
|
<p>If a deprecation warning has been added, please remember to mention it in the pull request so that others can update it later.</p>
|
735
|
-
|
736
|
-
<h1 id="maintainer-s-notes">Maintainer’s Notes</h1>
|
737
|
-
|
741
|
+
<h1 id="maintainers-notes">Maintainer’s Notes</h1>
|
738
742
|
<p>To install this gem onto your local machine from source, run <code>bundle exec rake install</code>.</p>
|
739
|
-
|
740
743
|
<p>To release a new version, follow theese steps:</p>
|
741
|
-
|
742
744
|
<ol>
|
743
745
|
<li>Update the version number in <code>version.rb</code></li>
|
744
746
|
<li>Run <code>bundle exec rake install</code>, which will update <code>gemfile.lock</code> with the correct version and all dependency changes</li>
|
@@ -748,11 +750,10 @@ alias rbcli='/path/to/rbcli/exe/rbcli'
|
|
748
750
|
</ol>
|
749
751
|
|
750
752
|
|
751
|
-
<footer class="
|
753
|
+
<footer class="footline">
|
752
754
|
|
753
755
|
</footer>
|
754
756
|
|
755
|
-
|
756
757
|
|
757
758
|
</div>
|
758
759
|
|
@@ -1177,20 +1178,19 @@ alias rbcli='/path/to/rbcli/exe/rbcli'
|
|
1177
1178
|
<div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
|
1178
1179
|
<div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
|
1179
1180
|
</div>
|
1180
|
-
<script src="/rbcli/js/clipboard.min.js?
|
1181
|
-
<script src="/rbcli/js/perfect-scrollbar.min.js?
|
1182
|
-
<script src="/rbcli/js/perfect-scrollbar.jquery.min.js?
|
1183
|
-
<script src="/rbcli/js/jquery.sticky.js?
|
1184
|
-
<script src="/rbcli/js/featherlight.min.js?
|
1185
|
-
<script src="/rbcli/js/
|
1186
|
-
<script src="/rbcli/js/highlight.pack.js?1561087612"></script>
|
1181
|
+
<script src="/rbcli/js/clipboard.min.js?1596148729"></script>
|
1182
|
+
<script src="/rbcli/js/perfect-scrollbar.min.js?1596148729"></script>
|
1183
|
+
<script src="/rbcli/js/perfect-scrollbar.jquery.min.js?1596148729"></script>
|
1184
|
+
<script src="/rbcli/js/jquery.sticky.js?1596148729"></script>
|
1185
|
+
<script src="/rbcli/js/featherlight.min.js?1596148729"></script>
|
1186
|
+
<script src="/rbcli/js/highlight.pack.js?1596148729"></script>
|
1187
1187
|
<script>hljs.initHighlightingOnLoad();</script>
|
1188
|
-
<script src="/rbcli/js/modernizr.custom-3.6.0.js?
|
1189
|
-
<script src="/rbcli/js/learn.js?
|
1190
|
-
<script src="/rbcli/js/hugo-learn.js?
|
1188
|
+
<script src="/rbcli/js/modernizr.custom-3.6.0.js?1596148729"></script>
|
1189
|
+
<script src="/rbcli/js/learn.js?1596148729"></script>
|
1190
|
+
<script src="/rbcli/js/hugo-learn.js?1596148729"></script>
|
1191
1191
|
|
1192
|
-
<link href="/rbcli/mermaid/mermaid.css?
|
1193
|
-
<script src="/rbcli/mermaid/mermaid.js?
|
1192
|
+
<link href="/rbcli/mermaid/mermaid.css?1596148729" rel="stylesheet" />
|
1193
|
+
<script src="/rbcli/mermaid/mermaid.js?1596148729"></script>
|
1194
1194
|
<script>
|
1195
1195
|
mermaid.initialize({ startOnLoad: true });
|
1196
1196
|
</script>
|