-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathCONTRIBUTING.docbook.xml
103 lines (85 loc) · 3.06 KB
/
CONTRIBUTING.docbook.xml
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
<?xml version="1.0" encoding="UTF-8"?>
<article xmlns="http://docbook.org/ns/docbook" xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="index" xml:lang="en">
<info>
<title>shlomifish.org Contributing guidelines [by Shlomi Fish]</title>
<date>2024-10-17</date>
<authorgroup>
<author>
<personname>
<firstname>Shlomi</firstname>
<surname>Fish</surname>
</personname>
<affiliation>
<address>
<email>[email protected]</email>
<uri type="homepage" xlink:href="http://www.shlomifish.org/">Shlomi Fish’s Homepage</uri>
</address>
</affiliation>
</author>
</authorgroup>
<copyright>
<year>2022</year>
<holder>Shlomi Fish</holder>
</copyright>
<legalnotice xml:id="main_legal_notice">
<info>
<title>CC-by-nc-sa dedication</title>
</info>
<para>
<!--Creative Commons License-->
This work is licensed under the <link xlink:href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution Non-commercial ShareAlike 4.0 License (CC-by-nc-sa)</link> (or at your option a greater version of it).
</para>
</legalnotice>
</info>
<section xml:id="docker">
<info>
<title>Docker script</title>
</info>
<programlisting>
perl bin/docker-ci-run.pl --cleanrun 2>&1 | tee "${HOME}/shlomif-homepage.build.out.txt"
</programlisting>
</section>
<section xml:id="directories-structure">
<info>
<title>Project Directory Structure</title>
</info>
<para>
The <filename class="directory">bin/</filename> directory contains sources for
executables, either those placed there by git, or those by cookiecutter and
the rest of <filename>./gen-helpers</filename>. Most of them can and should assume that the PWD is at <filename class="directory">./bin/..</filename>: the repository root.
</para>
<para>
The <filename class="directory">Tests/</filename> directory contains test programs, either
ones written in Python and which have a <code>.py</code> extension, or written in Perl and
which have a <code>.t</code> extension.
</para>
<para>
The <filename class="directory">Tests/lib</filename> directory contains Perl
and Python modules that are only used by the automated test scripts.
</para>
<para>
<code>bash -x bin/link-checker-for-shlomifish.org.bash</code> runs an
internal-hyperlinks checker. It is not run implicitly because it takes
a lot of time and resources.
<code>bash -x bin/link-checker-for-shlomifish.org.bash --only-check-site-flow</code>
is also available.
</para>
<para>
<filename class="directory">src/</filename> contains sources for pages
( <filename>*.xhtml.tt2</filename>, <filename>*.html.tt2</filename> )
as well as images ( <filename>*.png</filename> / etc. ).
</para>
<para>
<filename class="directory">lib/sass/</filename> contains SCSS sources
( <filename>*.scss</filename> ; <link xlink:href="https://sass-lang.com/guide/">SASS/SCSS guide</link>)
</para>
</section>
<section xml:id="preferred-formats">
<info>
<title>Preferred Formats</title>
</info>
<para>
See <link xlink:href="src/philosophy/computers/web/choice-of-docs-formats/index.xhtml.tt2">the “Choice of Document Formats” essay</link>.
</para>
</section>
</article>