Skip to content

Commit c626755

Browse files
AetherinoxAetherinox
committed
docs(mkdocs): housekeeping
1 parent 4500a4f commit c626755

29 files changed

+1061
-667
lines changed

‎docs/docs/about/contributing.md‎

Lines changed: 0 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -41,48 +41,6 @@ Please review everything on this page before you submit your contribution.
4141

4242
<br />
4343

44-
- [About](#about)
45-
- [Issues, Bugs, Ideas](#issues-bugs-ideas)
46-
- [Contributing](#contributing)
47-
- [Before Submitting Pull Requests](#before-submitting-pull-requests)
48-
- [Conventional Commit Specification](#conventional-commit-specification)
49-
- [Types](#types)
50-
- [Example 1:](#example-1)
51-
- [Example 2:](#example-2)
52-
- [Committing](#committing)
53-
- [Languages](#languages)
54-
- [Perl](#perl)
55-
- [Indentation](#indentation)
56-
- [Line Length](#line-length)
57-
- [Blank Lines](#blank-lines)
58-
- [Imports](#imports)
59-
- [Commenting](#commenting)
60-
- [Casing](#casing)
61-
- [Python](#python)
62-
- [Indentation](#indentation-1)
63-
- [Line Length](#line-length-1)
64-
- [Blank Lines](#blank-lines-1)
65-
- [Imports](#imports-1)
66-
- [Commenting](#commenting-1)
67-
- [Casing](#casing-1)
68-
- [NodeJS](#nodejs)
69-
- [Prettier](#prettier)
70-
- [ESLint](#eslint)
71-
- [v9 \& Newer (Config)](#v9--newer-config)
72-
- [v8 \& Older (Config)](#v8--older-config)
73-
- [Packages](#packages)
74-
- [Indentation](#indentation-2)
75-
- [Style](#style)
76-
- [Line Length](#line-length-2)
77-
- [Commenting](#commenting-2)
78-
- [Casing](#casing-2)
79-
80-
<br />
81-
82-
---
83-
84-
<br />
85-
8644
## Issues, Bugs, Ideas
8745

8846
Stuff happens, and sometimes as best as we try, there may be issues within this project that we are unaware of. That is the great thing about open-source; anyone can use the program and contribute to making it better.

‎docs/docs/about/conventions.md‎

Lines changed: 218 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -12,48 +12,232 @@ The badges in this section are for general use.
1212

1313
### <!-- md:flag --> Flags { #flags data-toc-label="Flags" }
1414

15-
=== "Description"
15+
These icons denote / mark a particular item with a specific category type. Use these to indicate that a feature or service is `experimental`,
16+
`dangerous`, `setting`, or `required`.
1617

17-
These icons denote / mark a particular item with a specific category type. Use these to indicate that a feature or service is `experimental`,
18-
`dangerous`, `setting`, or `required`.
18+
: <!-- md:flag --> Default `<!-- @md:flag -->`
19+
: <!-- md:flag experimental --> Experimental `<!-- @md:flag experimental -->`
20+
: <!-- md:flag required --> Required `<!-- @md:flag required -->`
21+
: <!-- md:flag customization --> Customization `<!-- @md:flag customization -->`
22+
: <!-- md:flag metadata --> Metadata `<!-- @md:flag metadata -->`
23+
: <!-- md:flag dangerous --> Dangerous `<!-- @md:flag dangerous -->`
24+
: <!-- md:flag multiple --> Multiple `<!-- @md:flag multiple -->`
25+
: <!-- md:flag setting --> Setting `<!-- @md:flag setting -->`
1926

20-
`Examples`
27+
<br />
28+
29+
#### Default
30+
<!-- md:flag --> Default `<!-- @md:flag -->`
2131

22-
: <!-- md:flag --> Default `<!-- @md:flag -->`
23-
: <!-- md:flag experimental --> Experimental `<!-- @md:flag experimental -->`
24-
: <!-- md:flag required --> Required `<!-- @md:flag required -->`
25-
: <!-- md:flag customization --> Customization `<!-- @md:flag customization -->`
26-
: <!-- md:flag metadata --> Metadata `<!-- @md:flag metadata -->`
27-
: <!-- md:flag dangerous --> Dangerous `<!-- @md:flag dangerous -->`
28-
: <!-- md:flag multiple --> Multiple `<!-- @md:flag multiple -->`
29-
: <!-- md:flag setting --> Setting `<!-- @md:flag setting -->`
32+
Indicates that an entry is a configurable setting or feature. Not specifying a valid flag will simply show an icon with no label.
3033

34+
<br />
35+
<br />
3136

37+
#### Experimental
38+
<!-- md:flag experimental --> Experimental `<!-- @md:flag experimental -->`
3239

40+
Indicates that this feature is experimental or in a testing phase. Its behavior may change in future releases.
41+
42+
<br />
3343
<br />
3444

45+
#### Required
46+
<!-- md:flag required --> Required `<!-- @md:flag required -->`
3547

48+
Indicates that this setting cannot be empty or null. A value **must** be provided for CSF to successfully validate it.
3649

37-
### <!-- md:control --> Controls { #controls data-toc-label="Controls" }
50+
<br />
51+
<br />
3852

39-
=== "Description"
53+
#### Customization
54+
<!-- md:flag customization --> Customization `<!-- @md:flag customization -->`
4055

41-
These icons deonote what type of control a specified setting uses if the settings are controlled by a graphical user interface.
56+
Indicates that the thing described is a customization that must be added by the end-user.
4257

43-
`Examples`
58+
<br />
59+
<br />
60+
61+
#### Metadata
62+
<!-- md:flag metadata --> Metadata `<!-- @md:flag metadata -->`
63+
64+
This symbol denotes that the thing described is a metadata property, which can be
65+
used in Markdown documents as part of the front matter definition.
66+
67+
<br />
68+
<br />
69+
70+
#### Multiple Instances
71+
<!-- md:flag multiple --> Multiple `<!-- @md:flag multiple -->`
72+
73+
Indicates that a specific feature can be utilized in multiple-instances, or it denotes multiple CSF themes.
74+
75+
<br />
76+
<br />
77+
78+
#### Setting
79+
<!-- md:flag setting --> Setting `<!-- @md:flag setting -->`
80+
81+
Indicates the subject being described is a user configurable setting, or is part of the CSF config file at
82+
`/etc/csf/csf.conf`.
83+
84+
<br />
85+
<br />
86+
87+
#### Dangerous
88+
<!-- md:flag dangerous --> Dangerous `<!-- @md:flag dangerous -->`
89+
90+
Indicates that modifying the specified setting, or changing a specific feature within CSF, can result
91+
in stability issues, or be less secure than the alternative.
92+
93+
Change this setting at your own descretion.
94+
95+
<br />
96+
<br />
97+
98+
---
99+
100+
<br />
101+
<br />
102+
103+
### <!-- md:control --> Controls { #controls data-toc-label="Controls" }
104+
105+
These icons deonote what type of control a specified setting uses if the settings are controlled by a graphical user interface.
106+
107+
: <!-- md:control --> default `<!-- @md:control -->`
108+
: <!-- md:control toggle --> toggle `<!-- @md:control toggle -->`
109+
: <!-- md:control toggle_on --> toggle on `<!-- @md:control toggle_on -->`
110+
: <!-- md:control toggle_off --> toggle off `<!-- @md:control toggle_off -->`
111+
: <!-- md:control textbox --> textbox `<!-- @md:control textbox -->`
112+
: <!-- md:control dropdown --> dropdown `<!-- @md:control dropdown -->`
113+
: <!-- md:control button --> button `<!-- @md:control button -->`
114+
: <!-- md:control slider --> slider `<!-- @md:control slider -->`
115+
: <!-- md:control volume --> docker volume `<!-- @md:control volume -->`
116+
: <!-- md:control env --> env variable `<!-- @md:control env -->`
117+
: <!-- md:control color #FFFFFF #121315 --> `<!-- @md:control color #FFFFFF #121315 -->`
118+
119+
<br />
120+
121+
#### Default
122+
<!-- md:control --> Default `<!-- @md:control -->`
123+
124+
Indicates that a control is a textbox.
125+
126+
<br />
127+
<br />
128+
129+
#### Toggle
130+
<!-- md:control toggle --> Toggle `<!-- @md:control toggle -->`
131+
132+
Indicates that a graphical user interface control is a toggle switch.
133+
134+
<br />
135+
<br />
136+
137+
#### Toggle (On)
138+
<!-- md:control toggle_on --> Toggle (On) `<!-- @md:control toggle_on -->`
139+
140+
Indicates that a graphical user interface control is a toggle switch set in the **on** position.
141+
142+
<br />
143+
<br />
144+
145+
#### Toggle (Off)
146+
<!-- md:control toggle_off --> Toggle (Off) `<!-- @md:control toggle_off -->`
44147

45-
: <!-- md:control --> default `<!-- @md:control -->`
46-
: <!-- md:control toggle --> toggle `<!-- @md:control toggle -->`
47-
: <!-- md:control toggle_on --> toggle on `<!-- @md:control toggle_on -->`
48-
: <!-- md:control toggle_off --> toggle off `<!-- @md:control toggle_off -->`
49-
: <!-- md:control textbox --> textbox `<!-- @md:control textbox -->`
50-
: <!-- md:control dropdown --> dropdown `<!-- @md:control dropdown -->`
51-
: <!-- md:control button --> button `<!-- @md:control button -->`
52-
: <!-- md:control slider --> slider `<!-- @md:control slider -->`
53-
: <!-- md:control volume --> docker volume `<!-- @md:control volume -->`
54-
: <!-- md:control env --> env variable `<!-- @md:control env -->`
55-
: <!-- md:control color #FFFFFF #121315 --> `<!-- @md:control color #FFFFFF #121315 -->`
148+
Indicates that a graphical user interface control is a toggle switch set in the **off** position.
56149

150+
<br />
151+
<br />
152+
153+
#### Textbox
154+
<!-- md:control textbox --> Textbox `<!-- @md:control textbox -->`
155+
156+
Indicates that a graphical user interface control is a textbox.
157+
158+
<br />
159+
<br />
160+
161+
#### Dropdown
162+
<!-- md:control dropdown --> Dropdown `<!-- @md:control dropdown -->`
163+
164+
Indicates that a graphical user interface control is a dropdown / select box.
165+
166+
<br />
167+
<br />
168+
169+
#### Button
170+
<!-- md:control button --> Button `<!-- @md:control button -->`
171+
172+
Indicates that a graphical user interface control is a button.
173+
174+
<br />
175+
<br />
176+
177+
#### Slider
178+
<!-- md:control slider --> Slider `<!-- @md:control slider -->`
179+
180+
Indicates that a graphical user interface control is a slider / range input.
181+
182+
<br />
183+
<br />
184+
185+
#### Docker Volume { #volume data-toc-label="Volume" }
186+
<!-- md:control volume --> Volume `<!-- @md:control volume -->`
187+
188+
Indicates that an item is a mountable docker volume.
189+
190+
<br />
191+
<br />
192+
193+
#### Env
194+
<!-- md:control env --> Environment Variable `<!-- @md:control env -->`
195+
196+
Indicates that an item is a environment variable.
197+
198+
<br />
199+
<br />
200+
201+
#### Color
202+
<!-- md:control color #FFFFFF #121315 --> Color `<!-- @md:control color #FFFFFF #121315 -->`
203+
204+
Indicates that a graphical user interface control accepts a color property.
205+
206+
<br />
207+
<br />
208+
209+
---
210+
211+
<br />
212+
<br />
213+
214+
### <!-- md:argument --> Argument { #argumentsdata-toc-label="Argument" }
215+
216+
Denotes a command argument.
217+
218+
: <!-- md:argument --> default `<!-- @md:argument -->`
219+
: <!-- md:argument `<protocol>` --> default `<!-- @md:argument `<protocol>` -->`
220+
221+
<br />
222+
223+
#### Default
224+
<!-- md:argument --> Default `<!-- @md:argument -->`
225+
226+
Not specifying an argument simply shows an icon.
227+
228+
<br />
229+
230+
#### Defined
231+
<!-- md:argument `<protocol>` --> <protocol> `<!-- @md:argument `<protocol>` -->`
232+
233+
Denotes a specified command argument.
234+
235+
<br />
236+
<br />
237+
238+
---
239+
240+
<br />
57241
<br />
58242

59243
### <!-- md:version --> Release Type { #release-types data-toc-label="Release Types" }
@@ -68,9 +252,9 @@ The badges in this section are for general use.
68252
: <!-- md:version --> default `<!-- @md:version -->`
69253
: <!-- md:version stable- --> stable `<!-- @md:version stable -->`
70254
: <!-- md:version development- --> development `<!-- @md:version development -->`
71-
: <!-- md:version 1.6.1 --> `<!-- @md:version 1.6.1 -->`
72-
: <!-- md:version stable-1.6.1 --> `<!-- @md:version stable-1.6.1 -->`
73-
: <!-- md:version development-1.6.1 --> `<!-- @md:version development-1.6.1 -->`
255+
: <!-- md:version 15.00 --> `<!-- @md:version 15.00 -->`
256+
: <!-- md:version stable-15.00 --> `<!-- @md:version stable-15.00 -->`
257+
: <!-- md:version development-15.00 --> `<!-- @md:version development-15.00 -->`
74258

75259

76260

@@ -140,8 +324,8 @@ The badges in this section are for general use.
140324
`Examples`
141325

142326
: <!-- md:docs --> `<!-- @md:docs -->`
143-
: <!-- md:docs ../advanced/services/blocklist.configserver/ self --> `<!-- @md:docs ../advanced/services/blocklist.configserver/ self -->`
144-
: <!-- md:docs ../advanced/services/blocklist.configserver/ self --> `<!-- @md:docs ../advanced/services/blocklist.configserver/ new -->`
327+
: <!-- md:docs ../services/blocklist.configserver.md self --> `<!-- @md:docs ../services/blocklist.configserver.md self -->`
328+
: <!-- md:docs ../services/blocklist.configserver.md new --> `<!-- @md:docs ../services/blocklist.configserver.md new -->`
145329

146330
<br />
147331

@@ -404,15 +588,15 @@ These are just generic examples with no specific purpose. They demonstrate how b
404588
<br />
405589

406590
#### <!-- md:flag setting --> DEBUG_ENABLED
407-
<!-- md:version stable-2.0.0 --> <!-- md:default `false` --> <!-- md:flag required --> <!-- md:fileViewDLExt test.zip https://example.com/test.zip -->
591+
<!-- md:version stable-15.00 --> <!-- md:default `false` --> <!-- md:flag required --> <!-- md:fileViewDLExt test.zip https://example.com/test.zip -->
408592

409593
This is an example setting.
410594

411595
=== "example.md"
412596

413597
```markdown
414598
#### <!-- @md:flag setting --> DEBUG_ENABLED
415-
<!-- @md:version stable-2.0.0 --> <!-- @md:default `false` --> <!-- @md:flag required --> <!-- @md:fileViewDLExt test.zip -->
599+
<!-- @md:version stable-15.00 --> <!-- @md:default `false` --> <!-- @md:flag required --> <!-- @md:fileViewDLExt test.zip -->
416600

417601
This is an example setting.
418602
```

‎docs/docs/blog/posts/release-15.02.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ This issue has been resolved, but there are some important considerations to not
175175

176176
React-based VestaCP templates are now minified `.js` and `.css` files rather than simple PHP and HTML. This change makes it significantly more challenging to modify the header and re-add CSF to the navigation menu, especially given hashed filenames in the build process; which we want to preserve the integrity of.
177177

178-
Rather than rebuilding the templates ourselves which seems like a drastic approach; I have provided instructions for users to manually integrate CSF into the VestaCP menu: [Add CSF to VestaCP Menu](https://docs.configserver.dev/install/install/#add-csf-to-vestacp-menu).
178+
Rather than rebuilding the templates ourselves which seems like a drastic approach; I have provided instructions for users to manually integrate CSF into the VestaCP menu: [Add CSF to VestaCP Menu](../../install/install.md#add-csf-menu).
179179

180180
Ideally, this would be solved by adding a conditional menu item in the header template, but VestaCP has not seen updates in some time, which brings us to the next point.
181181

‎docs/docs/blog/posts/release-15.07.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ By joining our Insiders Program as a sponsor, you’ll receive the following ben
4646

4747
- **Exclusive early access** to the ConfigServer Security & Firewall release channel
4848
- **Sponsor role** on our [Discord](https://discord.configserver.dev) server
49-
- Your GitHub avatar featured on our [Sponsors](../insiders/sponsors.md) page
49+
- Your GitHub avatar featured on our [Sponsors](../../insiders/sponsors.md) page
5050
- The opportunity to **suggest new perks** and help shape the future of the program
5151

5252
<br />

0 commit comments

Comments
 (0)