Initial commit

First commit of the Fedora i3 SIG docs. This copies basic information
from our wiki page and also instantiates a first draft of the SIG design
goals from the Pagure ticket.

* https://fedoraproject.org/wiki/SIGs/i3
* https://pagure.io/i3-sig/Fedora-i3-Spin/issue/10

Signed-off-by: Justin W. Flory <git@jwf.io>
This commit is contained in:
Justin Wheeler 2020-08-06 17:38:21 -04:00
commit 10736a508e
Signed by: jflory7
GPG key ID: 3AA2DC1FF6ABF0B6
13 changed files with 954 additions and 0 deletions

3
.gitignore vendored Normal file
View file

@ -0,0 +1,3 @@
build
cache
public

10
LICENSE.txt Normal file
View file

@ -0,0 +1,10 @@
The text of and illustrations in this document are licensed by Red Hat
under a Creative Commons AttributionShare Alike 3.0 Unported license
("CC-BY-SA"). An explanation of CC-BY-SA is available at
http://creativecommons.org/licenses/by-sa/3.0/. In accordance with
CC-BY-SA, if you distribute this document or an adaptation of it, you
must provide the URL for the original version.
Red Hat, as the licensor of this document, waives the right to
enforce, and agrees not to assert, Section 4d of CC-BY-SA to the
fullest extent permitted by applicable law.

122
README.md Normal file
View file

@ -0,0 +1,122 @@
# Fedora i3 SIG documentation
Official Fedora Documentation for the i3wm SIG
## Structure
```
|-- README.md
|-- antora.yml ....................... 1.
|-- build.sh ......................... 2.
|-- preview.sh ....................... 3.
|-- site.yml ......................... 4.
`-- modules
`-- ROOT ......................... 5.
|-- assets
| `-- images ............... 6.
| `-- pizza.png
|-- nav.adoc ................. 7.
`-- pages .................... 8.
|-- architecture.adoc
|-- community.adoc
|-- faq.adoc
|-- index.adoc
|-- pizza-dough.adoc
`-- pizza-oven.adoc
```
1. Metadata definition.
2. A script that does a local build. Uses docker.
3. A script that shows a preview of the site in a web browser by running a local web server. Uses docker.
4. A definition file for the build script.
5. A "root module of this documentation component". Please read below for an explanation.
6. **Images** to be used on any page.
7. **Menu definition.** Also defines the hierarchy of all the pages.
8. **Pages with the actual content.** They can be also organised into subdirectories if desired.
## Components and Modules
Antora introduces two new terms:
* **Component** — Simply put, a component is a part of the documentation website with its own menu. Components can also be versioned. In the Fedora Docs, we use separate components for user documentation, the Fedora Poject, Fedora council, Mindshare, FESCO, but also subprojects such as CommOps or Modulartity.
* **Module** — A component can be broken down into multiple modules. Modules still share a single menu on the site, but their sources can be stored in different git repositories, even owned by different groups. The default module is called "ROOT" (that's what is in this example). If you don't want to use multiple modules, only use "ROOT". But to define more modules, simply duplicate the "ROOT" directory and name it anything you want. You can store modules in one or more git repositories.
## Local preview
This repo includes scripts to build and preview the contents of this repository.
**NOTE**: Please note that if you reference pages from other repositoreis, such links will be broken in this local preview as it only builds this repository. If you want to rebuild the whole Fedora Docs site, please see [the Fedora Docs build repository](https://pagure.io/fedora-docs/docs-fp-o/) for instructions.
Both scripts work on Fedora (using Podman) and macOS (using Docker).
To build and preview the site, run:
```
$ ./build.sh && ./preview.sh
```
The result will be available at http://localhost:8080
### Installing Podman on Fedora
Fedora Workstation doesn't come with Podman preinstalled by default — so you might need to install it using the following command:
```
$ sudo dnf install podman
```
### Preview as a part of the whole Fedora Docs site
You can also build the whole Fedora Docs site locally to see your changes in the whole context.
This is especially useful for checking if your `xref` links work properly.
To do this, you need to clone the main [Fedora Docs build repository](https://pagure.io/fedora-docs/docs-fp-o), modify the `site.yml` file to reference a repo with your changes, and build it.
Steps:
Clone the main repository and cd into it:
```
$ git clone https://pagure.io/fedora-docs/docs-fp-o.git
$ cd docs-fp-o
```
Find a reference to the repository you're changing in the `site.yml` file, and change it so it points to your change.
So for example, if I made a modification to the Modularity docs, I would find:
```
...
- url: https://pagure.io/fedora-docs/modularity.git
branches:
- master
...
```
And replaced it with a pointer to my fork:
```
...
- url: https://pagure.io/forks/asamalik/fedora-docs/modularity.git
branches:
- master
...
```
I could also point to a local repository, using `HEAD` as a branch to preview the what's changed without the need of making a commit.
**Note:** I would need to move the repository under the `docs-fp-o` directory, because the builder won't see anything above.
So I would need to create a `repositories` directory in `docs-fp-o` and copy my repository into it.
```
...
- url: ./repositories/modularity
branches:
- HEAD
...
```
To build the whole site, I would run the following in the `docs-fp-o` directory.
```
$ ./build.sh && ./preview.sh
```

16
antora.yml Normal file
View file

@ -0,0 +1,16 @@
# Name will be mostly visible in the URL. Treat it as an indentifier.
# Tip: If you want to use the local preview scripts that come with this repository, please change this value in the site.yml file as well. (under site/start_page)
name: i3
# Title will be visible on the page.
title: Fedora i3 S.I.G.
# If you don't plan to have multiple versions of the docs (for example, to document multiple versions of some software), you can ignore this field. Otherwise, change "master" to a specific version.
version: master
# We encourage you to name the index page as "index.adoc". If you absolutely have to use a different name, please reflect it here. You can ignore this field otherwise.
start_page: ROOT:index
# This lists all the menu definitions of your component.
nav:
- modules/ROOT/nav.adoc

46
build.sh Executable file
View file

@ -0,0 +1,46 @@
#!/bin/sh
image="docker.io/antora/antora"
cmd="--html-url-extension-style=indexify site.yml"
if [ "$(uname)" = "Darwin" ]; then
# Running on macOS.
# Let's assume that the user has the Docker CE installed
# which doesn't require a root password.
echo ""
echo "This build script is using Docker container runtime to run the build in an isolated environment."
echo ""
docker run --rm -it -v "$(pwd):/antora" $image $cmd
elif [ "$(expr substr "$(uname -s)" 1 5)" = "Linux" ]; then
# Running on Linux.
# Check whether podman is available, else faill back to docker
# which requires root.
if [ -f /usr/bin/podman ]; then
echo ""
echo "This build script is using Podman to run the build in an isolated environment."
echo ""
podman run --rm -it -v "$(pwd):/antora:z" $image $cmd
elif [ -f /usr/bin/docker ]; then
echo ""
echo "This build script is using Docker to run the build in an isolated environment."
echo ""
if groups | grep -wq "docker"; then
docker run --rm -it -v "$(pwd):/antora:z" $image $cmd
else
echo ""
echo "This build script is using $runtime to run the build in an isolated environment. You might be asked for your password."
echo "You can avoid this by adding your user to the 'docker' group, but be aware of the security implications. See https://docs.docker.com/install/linux/linux-postinstall/."
echo ""
sudo docker run --rm -it -v "$(pwd):/antora:z" $image $cmd
fi
else
echo ""
echo "Error: Container runtime haven't been found on your system. Fix it by:"
echo "$ sudo dnf install podman"
exit 1
fi
fi

View file

@ -0,0 +1,611 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- Created with Inkscape (http://www.inkscape.org/) -->
<svg
xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:cc="http://creativecommons.org/ns#"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns="http://www.w3.org/2000/svg"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
width="8508.0322"
height="2453.6248"
id="svg2"
sodipodi:version="0.32"
inkscape:version="0.48.4 r9939"
sodipodi:docname="logo.svg"
inkscape:output_extension="org.inkscape.output.svg.inkscape"
version="1.1">
<defs
id="defs4">
<linearGradient
id="linearGradient3750">
<stop
style="stop-color:#17273b;stop-opacity:1;"
offset="0"
id="stop3752" />
<stop
id="stop4356"
offset="0.41666666"
style="stop-color:#008cd4;stop-opacity:0.78039217;" />
<stop
style="stop-color:#6eb5de;stop-opacity:0.69803923;"
offset="0.87847221"
id="stop4358" />
<stop
style="stop-color:#88bfe5;stop-opacity:0.61960787;"
offset="1"
id="stop3754" />
</linearGradient>
<inkscape:perspective
id="perspective3661"
inkscape:persp3d-origin="750.50629 : 505.26732 : 1"
inkscape:vp_z="683.5728 : 1230.5721 : 1"
inkscape:vp_y="0 : 1946.8917 : 0"
inkscape:vp_x="-526.84957 : 2.2065866e-13 : 0"
sodipodi:type="inkscape:persp3d" />
<linearGradient
id="linearGradient3284">
<stop
style="stop-color:#ffffff;stop-opacity:1;"
offset="0"
id="stop3286" />
<stop
style="stop-color:#ffffff;stop-opacity:0.7518248;"
offset="1"
id="stop3288" />
</linearGradient>
<linearGradient
id="linearGradient3278">
<stop
id="stop3280"
offset="0"
style="stop-color:#33bff7;stop-opacity:0.38039216;" />
<stop
id="stop3282"
offset="1"
style="stop-color:#2d446b;stop-opacity:1;" />
</linearGradient>
<linearGradient
id="linearGradient3272">
<stop
id="stop3274"
offset="0"
style="stop-color:#2596f6;stop-opacity:0.38039216;" />
<stop
id="stop3276"
offset="1"
style="stop-color:#2d446b;stop-opacity:1;" />
</linearGradient>
<linearGradient
id="linearGradient3266">
<stop
id="stop3268"
offset="0"
style="stop-color:#189fff;stop-opacity:0.38039216;" />
<stop
id="stop3270"
offset="1"
style="stop-color:#010b2b;stop-opacity:1;" />
</linearGradient>
<linearGradient
id="linearGradient3244">
<stop
id="stop3246"
offset="0"
style="stop-color:#419bff;stop-opacity:1;" />
<stop
id="stop3248"
offset="1"
style="stop-color:#002359;stop-opacity:1;" />
</linearGradient>
<linearGradient
id="linearGradient3159">
<stop
style="stop-color:#33bff7;stop-opacity:0.38039216;"
offset="0"
id="stop3161" />
<stop
style="stop-color:#2d446b;stop-opacity:1;"
offset="1"
id="stop3163" />
</linearGradient>
<inkscape:perspective
sodipodi:type="inkscape:persp3d"
inkscape:vp_x="-526.84957 : 2.9848654e-13 : 0"
inkscape:vp_y="1.192088e-13 : 1946.8917 : 0"
inkscape:vp_z="680.54236 : 1232.3792 : 1"
inkscape:persp3d-origin="730.30325 : 937.39936 : 1"
id="perspective10" />
<radialGradient
inkscape:collect="always"
xlink:href="#linearGradient3244"
id="radialGradient3256"
cx="344.73471"
cy="77.263504"
fx="344.73471"
fy="77.263504"
r="196.15704"
gradientTransform="matrix(-1.39796,-0.05336032,0.08355111,-2.1889079,820.20461,272.08319)"
gradientUnits="userSpaceOnUse" />
<radialGradient
inkscape:collect="always"
xlink:href="#linearGradient3159"
id="radialGradient3264"
cx="140.3363"
cy="300.27451"
fx="140.3363"
fy="300.27451"
r="206.15704"
gradientTransform="matrix(0.6771172,-0.6830119,1.1802789,1.1700925,-161.83993,77.639162)"
gradientUnits="userSpaceOnUse" />
<radialGradient
inkscape:collect="always"
xlink:href="#linearGradient3284"
id="radialGradient3290"
cx="267.50388"
cy="337.12692"
fx="267.50388"
fy="337.12692"
r="77.845421"
gradientTransform="matrix(1,0,0,0.7430849,0,86.613009)"
gradientUnits="userSpaceOnUse" />
<inkscape:perspective
id="perspective3373"
inkscape:persp3d-origin="372.04724 : 350.78739 : 1"
inkscape:vp_z="744.09448 : 526.18109 : 1"
inkscape:vp_y="0 : 1000 : 0"
inkscape:vp_x="0 : 526.18109 : 1"
sodipodi:type="inkscape:persp3d" />
<linearGradient
id="linearGradient3211">
<stop
id="stop3213"
offset="0"
style="stop-color: rgb(0, 160, 255); stop-opacity: 1;" />
<stop
id="stop3215"
offset="1"
style="stop-color: rgb(0, 37, 255); stop-opacity: 1;" />
</linearGradient>
<filter
inkscape:collect="always"
id="filter3406"
color-interpolation-filters="sRGB">
<feGaussianBlur
inkscape:collect="always"
stdDeviation="13.396228"
id="feGaussianBlur3408" />
</filter>
<radialGradient
inkscape:collect="always"
xlink:href="#linearGradient3284"
id="radialGradient3416"
cx="119.96373"
cy="229.28981"
fx="119.96373"
fy="229.28981"
r="203.19508"
gradientTransform="matrix(0.7210805,2.1168143,-1.4722239,0.5015047,347.53034,-320.94088)"
gradientUnits="userSpaceOnUse" />
<radialGradient
inkscape:collect="always"
xlink:href="#linearGradient3266"
id="radialGradient3423"
gradientUnits="userSpaceOnUse"
gradientTransform="matrix(9.0785365,-9.2630105,16.085822,15.212343,-6979.1531,-2584.4202)"
cx="351.15485"
cy="372.06332"
fx="351.15485"
fy="372.06332"
r="163.57143" />
<radialGradient
inkscape:collect="always"
xlink:href="#linearGradient3284"
id="radialGradient3734"
gradientUnits="userSpaceOnUse"
gradientTransform="matrix(0.7210805,2.1168143,-1.4722239,0.5015047,347.53034,-320.94088)"
cx="119.96373"
cy="229.28981"
fx="119.96373"
fy="229.28981"
r="203.19508" />
<radialGradient
inkscape:collect="always"
xlink:href="#linearGradient3284"
id="radialGradient3736"
gradientUnits="userSpaceOnUse"
gradientTransform="matrix(0.7210805,2.1168143,-1.4722239,0.5015047,347.53034,-320.94088)"
cx="119.96373"
cy="229.28981"
fx="119.96373"
fy="229.28981"
r="203.19508" />
<radialGradient
inkscape:collect="always"
xlink:href="#linearGradient3750"
id="radialGradient3758"
cx="390.69662"
cy="258.92429"
fx="390.69662"
fy="258.92429"
r="32.03125"
gradientTransform="matrix(4.0292425,-5.5974184,5.1695404,3.721239,-2510.9809,1613.1551)"
gradientUnits="userSpaceOnUse" />
<radialGradient
inkscape:collect="always"
xlink:href="#linearGradient3750"
id="radialGradient3760"
cx="59.046589"
cy="248.2272"
fx="59.046589"
fy="248.2272"
r="197.15625"
gradientTransform="matrix(1.7105919,-0.04370519,0.03334715,1.3051856,-58.593126,-250.18318)"
gradientUnits="userSpaceOnUse" />
<radialGradient
inkscape:collect="always"
xlink:href="#linearGradient3750"
id="radialGradient3762"
cx="192.64008"
cy="282.40387"
fx="192.64008"
fy="282.40387"
r="133.09375"
gradientTransform="matrix(1.0081228,0.4493093,-1.0529321,2.3624813,273.13721,-455.12138)"
gradientUnits="userSpaceOnUse" />
<radialGradient
inkscape:collect="always"
xlink:href="#linearGradient3750"
id="radialGradient4344"
gradientUnits="userSpaceOnUse"
gradientTransform="matrix(5.7478532,-0.5889281,0.4834745,4.7186431,-260.98332,-919.446)"
cx="24"
cy="280.45392"
fx="24"
fy="280.45392"
r="65.0625" />
<linearGradient
inkscape:collect="always"
xlink:href="#linearGradient3750"
id="linearGradient4354"
x1="-125.59599"
y1="-100.47679"
x2="-5.2882538"
y2="-100.47679"
gradientUnits="userSpaceOnUse" />
</defs>
<sodipodi:namedview
id="base"
pagecolor="#ffffff"
bordercolor="#666666"
borderopacity="1.0"
inkscape:pageopacity="0.0"
inkscape:pageshadow="2"
inkscape:zoom="0.1767767"
inkscape:cx="3023.4499"
inkscape:cy="-756.29715"
inkscape:document-units="px"
inkscape:current-layer="layer1"
showgrid="false"
inkscape:window-width="2357"
inkscape:window-height="1952"
inkscape:window-x="1475"
inkscape:window-y="168"
fit-margin-top="0"
fit-margin-left="0"
fit-margin-right="0"
fit-margin-bottom="0"
inkscape:window-maximized="0"
units="px" />
<metadata
id="metadata7">
<rdf:RDF>
<cc:Work
rdf:about="">
<dc:format>image/svg+xml</dc:format>
<dc:type
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
<dc:title></dc:title>
<dc:contributor>
<cc:Agent>
<dc:title>yellowiscool, farvardin</dc:title>
</cc:Agent>
</dc:contributor>
<dc:creator>
<cc:Agent>
<dc:title>steckdenis</dc:title>
</cc:Agent>
</dc:creator>
<dc:description>Logo for I3, an improved dynamic tiling window manager: http://i3.zekjur.net/</dc:description>
<cc:license
rdf:resource="http://creativecommons.org/licenses/by-sa/3.0/" />
</cc:Work>
<cc:License
rdf:about="http://creativecommons.org/licenses/by-sa/3.0/">
<cc:permits
rdf:resource="http://creativecommons.org/ns#Reproduction" />
<cc:permits
rdf:resource="http://creativecommons.org/ns#Distribution" />
<cc:requires
rdf:resource="http://creativecommons.org/ns#Notice" />
<cc:requires
rdf:resource="http://creativecommons.org/ns#Attribution" />
<cc:permits
rdf:resource="http://creativecommons.org/ns#DerivativeWorks" />
<cc:requires
rdf:resource="http://creativecommons.org/ns#ShareAlike" />
</cc:License>
</rdf:RDF>
</metadata>
<g
inkscape:groupmode="layer"
id="layer4"
inkscape:label="fond"
style="display:none"
transform="translate(-403.16331,2196.6159)">
<rect
style="opacity:0.87000002;fill:#5599ff;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:60;marker:none;visibility:visible;display:inline;overflow:visible;enable-background:accumulate"
id="rect3241"
width="330"
height="313.5"
x="39"
y="103.86218" />
</g>
<g
inkscape:label="Calque 1"
inkscape:groupmode="layer"
id="layer1"
style="display:inline"
transform="translate(-403.16331,2196.6159)">
<rect
style="fill:#ffffff;fill-opacity:1;stroke:#ffffff;stroke-width:155.6656189;stroke-linecap:round;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none"
id="rect3836"
width="2380.248"
height="2290.5771"
x="507.66498"
y="-2114.5522" />
<rect
style="fill:url(#radialGradient3423);fill-opacity:1;fill-rule:nonzero;stroke:none"
id="rect2383"
width="2558.9255"
height="2445.6987"
x="407.12625"
y="-2192.6528" />
<path
style="opacity:0.09583333;fill:#ffffff;fill-opacity:1;stroke:none"
d="m 413.86349,-2192.5867 c -15.25265,33.2522 -2.32827,78.5617 -6.30947,116.6372 1.72096,380.4493 3.44192,760.8985 5.16287,1141.34766 93.88235,82.98568 229.27384,70.38365 345.4922,86.49033 423.97831,27.2898 850.31151,28.61862 1272.94371,-19.4116 269.6865,-27.22552 539.3778,-69.20434 799.6418,-145.93839 66.2578,-22.2482 149.4887,-73.1004 135.2925,-153.3025 0,-341.9409 0,-683.8819 0,-1025.8227 -850.7413,0 -1701.4825,0 -2552.22361,0 z"
id="path3221"
inkscape:connector-curvature="0" />
<g
transform="matrix(2.6849003,-2.6961195,2.6961195,2.6849003,536.88627,-838.56295)"
style="opacity:0.5;fill:#000000;fill-opacity:1;filter:url(#filter3406)"
id="g3394">
<path
style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:none"
d="M 412.75,98.59375 C 396.19379,98.835333 382.96319,112.44354 383.1875,129 c 0,0 -10e-6,87.25107 0,196.3125 0,23.30736 -12.11655,39.13192 -38.21875,53.46875 -26.1022,14.33683 -64.97276,22.875 -103.875,22.875 -38.90224,0 -77.7728,-8.53817 -103.875,-22.875 C 111.11655,364.44442 99,348.61986 99,325.3125 c 0,-54.37333 0.441249,-103.35555 0.65625,-138.875 0.1075,-17.75973 0.177008,-32.11577 0.09375,-42.34375 -0.04163,-5.11399 -0.129499,-9.10767 -0.28125,-12.46875 -0.07588,-1.68054 -0.136902,-3.05581 -0.40625,-5.25 -0.134674,-1.09709 -0.168072,-2.2122 -1,-5.1875 C 97.646536,119.69985 97.275733,117.79087 94.875,113.75 92.474267,109.70913 84.912085,98.999943 69,99 59.653467,98.879464 50.78473,103.12192 45.013008,110.47443 39.241286,117.82694 37.226064,127.44941 39.5625,136.5 c 0.06318,2.03091 0.15684,4.32729 0.1875,8.09375 0.07765,9.5394 0.0133,23.81477 -0.09375,41.5 C 39.442151,221.46421 39,270.62442 39,325.3125 c -10e-7,47.58256 30.913445,84.95437 69.34375,106.0625 38.43031,21.10813 85.6089,30.28125 132.75,30.28125 47.1411,0 94.31969,-9.17312 132.75,-30.28125 38.43031,-21.10813 69.34375,-58.47994 69.34375,-106.0625 -10e-6,-109.06142 0,-196.3125 0,-196.3125 0.10978,-8.10283 -3.06279,-15.9055 -8.79582,-21.63265 -5.73304,-5.72715 -13.53896,-8.891699 -21.64168,-8.7736 l 0,0 z"
id="path3396"
inkscape:connector-curvature="0" />
<path
style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:none"
d="M 239.5625,99.5 C 223.00629,99.741583 209.77569,113.34979 210,129.90625 L 210,350 c -0.15301,10.81908 5.53126,20.88244 14.87619,26.33663 9.34492,5.45419 20.9027,5.45419 30.24762,0 C 264.46874,370.88244 270.15301,360.81908 270,350 l 0,-220.09375 c 0.10978,-8.10283 -3.06279,-15.9055 -8.79582,-21.63265 -5.73304,-5.72715 -13.53896,-8.891699 -21.64168,-8.7736 l 0,0 z"
id="path3398"
inkscape:connector-curvature="0" />
<path
sodipodi:type="arc"
style="fill:#000000;fill-opacity:1;stroke-width:60;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none"
id="path3400"
sodipodi:cx="70"
sodipodi:cy="40"
sodipodi:rx="30"
sodipodi:ry="30"
d="M 100,40 C 100,56.568542 86.568542,70 70,70 53.431458,70 40,56.568542 40,40 40,23.431458 53.431458,10 70,10 c 16.568542,0 30,13.431458 30,30 z"
transform="translate(0,-10)" />
<path
transform="translate(170,-10)"
d="M 100,40 C 100,56.568542 86.568542,70 70,70 53.431458,70 40,56.568542 40,40 40,23.431458 53.431458,10 70,10 c 16.568542,0 30,13.431458 30,30 z"
sodipodi:ry="30"
sodipodi:rx="30"
sodipodi:cy="40"
sodipodi:cx="70"
id="path3402"
style="fill:#000000;fill-opacity:1;stroke-width:60;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none"
sodipodi:type="arc" />
<path
sodipodi:type="arc"
style="fill:#000000;fill-opacity:1;stroke-width:60;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none"
id="path3404"
sodipodi:cx="70"
sodipodi:cy="40"
sodipodi:rx="30"
sodipodi:ry="30"
d="M 100,40 C 100,56.568542 86.568542,70 70,70 53.431458,70 40,56.568542 40,40 40,23.431458 53.431458,10 70,10 c 16.568542,0 30,13.431458 30,30 z"
transform="translate(345,-10)" />
</g>
<g
style="font-size:110.96224976000000595px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#52c0ff;fill-opacity:1;stroke:none;font-family:Union;-inkscape-font-specification:Union"
id="text3058"
transform="translate(0,648.71053)">
<path
d="m 3677.9074,-1919.7283 -180.5613,0 0,-164.4 180.5613,0 0,164.4 m -264.7118,747.3234 0,-77.4631 105.8847,-40.1247 0,-375.6122 -120.9315,-42.3539 0,-98.0827 279.7586,0 0,516.0488 105.8848,40.1247 0,77.4631 -370.5966,0"
style="font-size:1141.32604979999996431px;font-weight:bold;fill:#52c0ff;-inkscape-font-specification:Union Bold;fill-opacity:1"
id="path3076"
inkscape:connector-curvature="0" />
<path
d="m 4037.3582,-1911.9262 -41.2393,114.244 -115.3586,0 0,-202.2956 c 109.2283,-13.0025 190.9638,-19.5042 245.2067,-19.505 197.2795,8e-4 295.9194,70.4048 295.92,211.2122 -6e-4,51.271 -17.4623,93.2534 -52.385,125.9471 -34.5524,32.3232 -80.25,52.757 -137.0929,61.3017 l 0,30.6508 c 25.2633,0.372 54.9853,5.9448 89.1661,16.7187 34.1798,10.7746 63.3445,30.4654 87.4942,59.0725 24.5201,28.2362 36.7804,65.0172 36.781,110.343 -6e-4,78.7636 -31.023,140.4367 -93.0671,185.0197 -61.6737,44.2115 -139.1367,66.3173 -232.3891,66.3173 -79.1352,0 -156.4124,-8.7309 -231.8319,-26.1926 l 16.1614,-108.6711 c 66.1313,13.0034 122.7889,19.5051 169.9728,19.505 136.3495,10e-5 204.5243,-45.6974 204.5248,-137.0928 -5e-4,-43.8398 -17.0906,-77.6485 -51.2705,-101.4265 -34.1808,-23.7772 -97.34,-35.666 -189.478,-35.6664 l -34.5518,0 0,-106.9993 43.4684,0 c 61.3014,4e-4 111.4573,-13.0029 150.4678,-39.0102 39.0098,-26.0062 58.5148,-62.7872 58.5153,-110.343 -5e-4,-38.638 -12.075,-67.8027 -36.2238,-87.4943 -24.1495,-20.0616 -58.5156,-30.0928 -103.0983,-30.0935 -22.6633,7e-4 -49.2273,1.4868 -79.6922,4.4583"
style="font-size:1141.32604979999996431px;font-weight:bold;fill:#52c0ff;-inkscape-font-specification:Union Bold;fill-opacity:1"
id="path3078"
inkscape:connector-curvature="0" />
</g>
<text
xml:space="preserve"
style="font-size:110.96224976px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;letter-spacing:0px;word-spacing:0px;text-anchor:start;fill:#ffffff;fill-opacity:1;stroke:none;font-family:Union;-inkscape-font-specification:Union"
x="3388.8596"
y="107.44135"
id="text3062"
sodipodi:linespacing="125%"><tspan
sodipodi:role="line"
x="3388.8596"
y="107.44135"
style="font-size:570.6630249px;fill:#ffffff;fill-opacity:1"
id="tspan3063">improved tiling wm</tspan></text>
</g>
<g
inkscape:groupmode="layer"
id="layer2"
inkscape:label="tiling"
style="display:none"
transform="translate(-403.16331,2196.6159)">
<rect
y="106.6479"
x="42.85714"
height="308.57144"
width="322.85715"
id="rect3247"
style="fill:none;stroke:#000000;stroke-width:1;stroke-linecap:round;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" />
<rect
style="fill:none;stroke:#000000;stroke-width:1;stroke-linecap:round;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0"
id="rect3253"
width="212.07706"
height="98.216858"
x="42.85096"
y="218.0385" />
<rect
style="fill:none;stroke:#000000;stroke-width:1;stroke-linecap:round;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0"
id="rect3257"
width="110.75323"
height="70.943619"
x="254.94135"
y="274.26196" />
<rect
y="218.02481"
x="254.93958"
height="56.235466"
width="110.76914"
id="rect3259"
style="fill:none;stroke:#000000;stroke-width:1;stroke-linecap:round;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" />
<rect
y="345.25272"
x="254.91608"
height="69.955116"
width="110.78036"
id="rect3255"
style="fill:none;stroke:#000000;stroke-width:1;stroke-linecap:round;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" />
<rect
style="fill:none;stroke:#000000;stroke-width:1;stroke-linecap:round;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0"
id="rect3249"
width="106.87583"
height="111.69163"
x="42.849949"
y="106.32091" />
<rect
y="106.45182"
x="149.72185"
height="111.57816"
width="105.18911"
id="rect3261"
style="fill:none;stroke:#000000;stroke-width:1;stroke-linecap:round;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" />
<rect
style="fill:none;stroke:#000000;stroke-width:1;stroke-linecap:round;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0"
id="rect3263"
width="110.786"
height="111.57211"
x="254.91632"
y="106.45485" />
<rect
y="316.22876"
x="42.847878"
height="98.979958"
width="212.0791"
id="rect3251"
style="fill:none;stroke:#000000;stroke-width:1;stroke-linecap:round;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0;display:inline" />
</g>
<g
inkscape:groupmode="layer"
id="layer5"
inkscape:label="tiling2"
style="display:inline"
transform="translate(-403.16331,2196.6159)">
<rect
y="-2192.6528"
x="407.12625"
height="2445.6987"
width="2558.9255"
id="rect3244"
style="fill:none;stroke:#000000;stroke-width:7.92587519;stroke-linecap:round;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0;display:inline" />
<rect
style="fill:none;stroke:#000000;stroke-width:7.92587519;stroke-linecap:round;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0;display:inline"
id="rect3246"
width="2558.9255"
height="2445.6987"
x="407.12625"
y="-2192.6528" />
<path
style="fill:none;stroke:#000000;stroke-width:7.92587519;stroke-linecap:round;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dashoffset:0;display:inline"
d="m 1516.7488,-2192.653 0,2445.6988 0,-2445.6988 z"
id="path73"
sodipodi:nodetypes="ccc"
inkscape:connector-curvature="0" />
<path
sodipodi:nodetypes="ccc"
id="path3254"
d="m 1513.2638,-1393.8379 -1102.65249,0 1102.65249,0 z"
style="fill:none;stroke:#000000;stroke-width:7.92587519;stroke-linecap:round;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0;marker:none;visibility:visible;display:inline;overflow:visible;enable-background:accumulate"
inkscape:connector-curvature="0" />
<path
style="fill:none;stroke:#000000;stroke-width:7.92587519;stroke-linecap:round;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0;marker:none;visibility:visible;display:inline;overflow:visible;enable-background:accumulate"
d="m 1513.2638,-553.69513 -1102.65249,0 1102.65249,0 z"
id="path3256"
sodipodi:nodetypes="ccc"
inkscape:connector-curvature="0" />
</g>
<g
inkscape:groupmode="layer"
id="layer3"
inkscape:label="I3"
style="display:inline"
transform="translate(-403.16331,2196.6159)">
<path
style="opacity:0.87000002;color:#000000;fill:#ffffff;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:60;marker:none;visibility:visible;display:inline;overflow:visible;enable-background:accumulate"
d="m 1910.8996,-1686.6719 c -43.8006,45.2862 -42.6341,117.4941 2.6064,161.3419 0,0 235.2392,234.2605 529.282,527.07952 62.8393,62.57796 72.9725,137.7329 41.5446,246.60061 -31.428,108.86761 -112.7716,236.59139 -217.2204,341.47644 -104.4485,104.88515 -231.8323,186.76064 -340.5677,218.64229 -108.7357,31.88176 -183.9323,22.06207 -246.7717,-40.51589 -146.597,-145.98708 -277.4742,-278.68913 -372.6616,-374.63493 -47.5938,-47.97291 -86.1127,-86.70483 -113.9122,-113.94145 -13.8996,-13.61834 -24.903,-24.10409 -34.3723,-32.71913 -4.7346,-4.30745 -8.6064,-7.83547 -15.2454,-13.00042 -3.3194,-2.58251 -6.4155,-5.48637 -16.671,-11.23181 -5.1277,-2.87267 -11.2701,-6.9983 -28.6106,-11.375 -17.3403,-4.37678 -66.5173,-12.74127 -109.2395,30.15978 -25.41947,24.87572 -37.79297,60.17755 -33.46619,95.47948 4.32669,35.30205 24.85939,66.57063 55.53399,84.57122 5.6452,5.28257 12.088,11.19556 22.3251,21.22547 25.9279,25.40294 64.2432,63.90443 111.6373,111.67611 94.7881,95.54346 226.1427,228.72579 373.5883,375.557869 128.2883,127.754376 312.0468,144.747557 472.1383,97.808209 160.0916,-46.939459 311.4932,-149.509768 438.0623,-276.607698 126.5694,-127.09813 228.5073,-278.92621 274.7788,-439.21204 46.2715,-160.28596 28.5121,-343.97193 -99.7762,-471.72633 -294.0426,-292.819 -529.282,-527.0795 -529.282,-527.0795 -21.5513,-22.0513 -51.1063,-34.4471 -81.9399,-34.3669 -30.8338,0.079 -60.324,12.6292 -81.7604,34.7922 l 0,0 z"
id="path2405"
inkscape:connector-curvature="0" />
<path
style="opacity:0.87000002;fill:#ffffff;fill-opacity:1;fill-rule:evenodd;stroke:none;display:inline"
d="m 1448.3517,-1217.3044 c -43.8005,45.2861 -42.6341,117.494 2.6065,161.3418 l 593.3989,590.92975 c 28.7587,29.46065 71.1525,41.15432 110.9479,30.60322 39.7953,-10.551 70.8268,-41.71214 81.2117,-81.55118 10.3852,-39.83905 -1.4851,-82.18356 -31.0655,-110.81923 l -593.399,-590.92976 c -21.5515,-22.0513 -51.1064,-34.447 -81.9402,-34.367 -30.8336,0.079 -60.3238,12.6293 -81.7603,34.7924 l 0,0 z"
id="path3179"
inkscape:connector-curvature="0" />
<path
sodipodi:type="arc"
style="opacity:0.87000002;color:#000000;fill:#ffffff;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:124.98213196;marker:none;visibility:visible;display:inline;overflow:visible;enable-background:accumulate"
id="path3181"
sodipodi:cx="70"
sodipodi:cy="40"
sodipodi:rx="30"
sodipodi:ry="30"
d="M 100,40 C 100,56.568542 86.568542,70 70,70 53.431458,70 40,56.568542 40,40 40,23.431458 53.431458,10 70,10 c 16.568542,0 30,13.431458 30,30 z"
transform="matrix(2.6849003,-2.6961195,2.6961195,2.6849003,509.92508,-865.41186)" />
<path
transform="matrix(2.6849003,-2.6961195,2.6961195,2.6849003,966.35812,-1323.7522)"
d="M 100,40 C 100,56.568542 86.568542,70 70,70 53.431458,70 40,56.568542 40,40 40,23.431458 53.431458,10 70,10 c 16.568542,0 30,13.431458 30,30 z"
sodipodi:ry="30"
sodipodi:rx="30"
sodipodi:cy="40"
sodipodi:cx="70"
id="path3183"
style="opacity:0.87000002;color:#000000;fill:#ffffff;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:124.98213196;marker:none;visibility:visible;display:inline;overflow:visible;enable-background:accumulate"
sodipodi:type="arc" />
<path
sodipodi:type="arc"
style="opacity:0.87000002;color:#000000;fill:#ffffff;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:124.98213196;marker:none;visibility:visible;display:inline;overflow:visible;enable-background:accumulate"
id="path3185"
sodipodi:cx="70"
sodipodi:cy="40"
sodipodi:rx="30"
sodipodi:ry="30"
d="M 100,40 C 100,56.568542 86.568542,70 70,70 53.431458,70 40,56.568542 40,40 40,23.431458 53.431458,10 70,10 c 16.568542,0 30,13.431458 30,30 z"
transform="matrix(2.6849003,-2.6961195,2.6961195,2.6849003,1436.2157,-1795.5732)" />
</g>
</svg>

After

Width:  |  Height:  |  Size: 28 KiB

2
modules/ROOT/nav.adoc Normal file
View file

@ -0,0 +1,2 @@
* xref:design-goals.adoc[Spin Design Goals]
* xref:faq.adoc[F.A.Q.]

View file

@ -0,0 +1,41 @@
= i3 Spin Design Goals
Justin W. Flory, Fedora i3 SIG
:page-authors: {author}, {author_2}
This page documents Design Goals the SIG always considers to the Fedora i3 Spin.
This explains what the Fedora i3 SIG prioritizes and focuses on when working on the Spin.
These Design Goals were first discussed in the https://meetbot.fedoraproject.org/fedora-i3/2020-07-21/i3.2020-07-21-16.06.log.html#l-98[2020-07-21 SIG meeting].
A first draft was proposed in https://pagure.io/i3-sig/Fedora-i3-Spin/issue/10#comment-666646[i3-sig/Fedora-i3-Spin#10].
== 1. Simple is better than complex.
*The Fedora i3 Spin will choose simplicity over complexity.*
Just because i3 is a Window Manager does not mean it needs to be difficult to do basic computing tasks (e.g. work on a document, connect to the Internet, connect Bluetooth headphones, etc.).
== 2. Fast is better than features.
*The Fedora i3 Spin will choose to be fast, lean, and quick instead of full of features.*
We know i3wm is used by people on a variety of hardware, including low-end consumer-grade hardware.
We also acknowledge advanced i3wm users often have their own preferences for extra applications.
The Fedora i3 Spin should work fast and quick on a variety of consumer hardware.
== 3. There should be one—and preferably only one—obvious way to do it.
*The Fedora i3 Spin will choose to maintain a single obvious way to do basic computing tasks.*
For example, bundling two document-editing suites or network connection managers is confusing and disruptive to the user experience.
It should be comfortable to use Fedora i3 Spin if you are an experienced Linux user, but new to i3 or window managers.
== 4. Now is better than never.
*The Fedora i3 Spin will choose to try out and experiment with new ideas.*
This helps us collect data and info about what to keep doing and what to do less of.
Even when we make a mistake, we will address it as expediently as possible, and then keep moving forward.

View file

@ -0,0 +1,12 @@
= Frequently Asked Questions (F.A.Q.)
[qanda]
Can I see a built preview of this template to get a better idea about the result?::
Of course you can!
Just look at the README of the repository — it should tell you everything.
Is writing documentation hard and dreadful?::
Absolutely not.
Writing documentation in asciidoc is very simple and straighforward.
And in fact, writing documentation makes you very happy.
Just try and see for yourself!

View file

@ -0,0 +1,39 @@
= Fedora i3 S.I.G.
Justin W. Flory, Fedora i3 SIG
:page-authors: {author}, {author_2}
Welcome to the home page of the *Fedora i3 Special Interest Group* (S.I.G.).
image::i3-logo.svg[Official logo of upstream i3wm project]
i3 is a tiling window manager for X11.
The goal of this SIG is to produce a Fedora i3-based Fedora Spin.
== Design Goals
See xref:[Fedora i3 Spin Design Goals].
== Communication
* *IRC*:
`#fedora-i3@chat.freenode.net` (https://webchat.freenode.net/#fedora-i3[_join web chat_])
* *Telegram*:
https://t.me/FedoraI3SIG[@FedoraI3SIG]
* *Mailing list*:
https://lists.fedoraproject.org/admin/lists/i3wm.lists.fedoraproject.org/[i3wm@lists.fp.o]
== Pagure and FAS
* https://pagure.io/i3-sig/Fedora-i3-Spin[i3 Spin Project]
* https://pagure.io/i3-SIG[i3 SIG group]
* https://admin.fedoraproject.org/accounts/group/view/i3-sig[i3-sig FAS Group]
== Suggested tasks
* List minimum of packages needed
* Is Sway included in the scope of this SIG?
* Is i3-gaps worthwhile to package officially for Fedora?

14
nginx.conf Normal file
View file

@ -0,0 +1,14 @@
server {
listen 80;
server_name localhost;
location / {
root /antora/public;
index index.html index.htm;
}
error_page 500 502 503 504 /50x.html;
location = /50x.html {
root /usr/share/nginx/html;
}
}

18
preview.sh Executable file
View file

@ -0,0 +1,18 @@
#!/bin/sh
if [ "$(uname)" = "Darwin" ]; then
# Running on macOS.
# Let's assume that the user has the Docker CE installed
# which doesn't require a root password.
echo "The preview will be available at http://localhost:8080/"
docker run --rm -v "$(pwd):/antora:ro" -v "$(pwd)/nginx.conf:/etc/nginx/conf.d/default.conf:ro" -p 8080:80 nginx
elif [ "$(expr substr "$(uname -s)" 1 5)" = "Linux" ]; then
# Running on Linux.
# Fedora Workstation has python3 installed as a default, so using that
echo ""
echo "The preview is available at http://localhost:8080"
echo ""
cd ./public
python3 -m http.server 8080
fi

20
site.yml Normal file
View file

@ -0,0 +1,20 @@
site:
title: Local Preview - Fedora i3 S.I.G.
start_page: i3::index
content:
sources:
- url: .
branches: HEAD
ui:
bundle:
url: https://asamalik.fedorapeople.org/ui-bundle.zip
snapshot: true
default_layout: with_menu
output:
clean: true
dir: ./public
destinations:
- provider: archive
runtime:
pull: true
cache_dir: ./cache