Commit Graph

248 Commits

Author SHA1 Message Date
Yoshiaki Senda
87fd3a5562 Add development-environment-vagrant
Add development-environment-vagrant to index.rst
2023-06-15 14:33:28 +09:00
Christian Goll
9e463c516e Merge pull request #850 from panda1100/patch-3
Add EL9 quickstart guide to index.rst
2023-06-13 11:35:09 +02:00
Yoshiaki Senda
8d674f6105 Merge branch 'development' into patch-2 2023-06-12 22:31:42 +09:00
Yoshiaki Senda
c640b37ca0 Add EL9 quickstart guide to index.rst 2023-06-12 22:28:20 +09:00
Christian Goll
b3ebb6bfd7 Merge pull request #849 from panda1100/panda1100-el9
Quickstart Guide for EL9
2023-06-12 14:49:33 +02:00
Jonathon Anderson
4910bbdfde Merge pull request #795 from anderbubble/userdocs-hostlist
Documentation and tests for hostlist syntax
2023-06-08 15:10:22 -06:00
Yoshiaki Senda
5e30205b63 Quickstart Guide for EL9
Quickstart Guide for EL9
2023-06-09 00:59:37 +09:00
Yoshiaki Senda
d81dcdf65b add genconfig line
* without `genconfig`, warewulfd doesn not read `/etc/warewulf/warewuld.conf`, and read `/usr/local/etc/warewulf/warewulf.conf` instead.
* added `genconfig` line to make our build configuration identical to rpm package one 

This fix #847
2023-06-09 00:39:16 +09:00
Yoshiaki Senda
55778b9d51 fix typo
fix package name to gpgme-devel
2023-06-08 12:24:19 +09:00
Jonathon Anderson
82cdd13987 Documentation and tests for hostlist syntax
Added this to a new top-level page for wwctl

Closes #611

Signed-off-by: Jonathon Anderson <janderson@ciq.co>
2023-06-05 05:06:59 -06:00
Christian Goll
27563db856 added genders examples 2023-05-23 16:48:13 +02:00
Brian Clemens
74df996550 Merge pull request #794 from anderbubble/userdocs-excludes
Document excludes and container_exit.sh
2023-04-22 14:47:08 +09:00
Brian Clemens
dddc82d10f Merge pull request #798 from anderbubble/userdocs-local-container
Document importing local container images
2023-04-22 13:33:46 +09:00
Brian Clemens
6fc507f546 Merge pull request #796 from anderbubble/userdocs-image-size
Add a userdocs section on container sizes and workarounds
2023-04-22 13:33:02 +09:00
Brian Clemens
a361ab3b83 Merge pull request #799 from anderbubble/userdocs-node-discoverable
Document node discovery and order in userdocs
2023-04-22 13:32:27 +09:00
Jonathon Anderson
f1c6cf73e7 Document node discovery and order in userdocs
Closes #487

Signed-off-by: Jonathon Anderson <janderson@ciq.co>
2023-04-21 16:56:07 -06:00
Jonathon Anderson
b0f3a8e4ae Document importing local container images
Closes #492

Signed-off-by: Jonathon Anderson <janderson@ciq.co>
2023-04-21 15:42:30 -06:00
Jonathon Anderson
d0a0feff15 Add a section on container sizes and workarounds
Signed-off-by: Jonathon Anderson <janderson@ciq.co>
2023-04-21 14:29:39 -06:00
Christian Goll
a4f036ad67 Merge pull request #793 from anderbubble/secure-true
Additional documentation for warewulf.conf:warewulf.secure
2023-04-21 09:43:37 +02:00
Jonathon Anderson
d9782688b1 Fix a hyperlink syntax error in userdocs
Signed-off-by: Jonathon Anderson <janderson@ciq.co>
2023-04-20 14:42:23 -06:00
Jonathon Anderson
1731636bc2 Document excludes and container_exit.sh
Closes #612

Signed-off-by: Jonathon Anderson <janderson@ciq.co>
2023-04-20 14:22:24 -06:00
Jonathon Anderson
951e10755a Additional documentation for warewulf.conf:warewulf.secure
Closes #615

Signed-off-by: Jonathon Anderson <janderson@ciq.co>
2023-04-20 13:35:11 -06:00
Jonathon Anderson
be9bd9d2bc Update Warewulf logos in userdocs
Closes #788

Signed-off-by: Jonathon Anderson <janderson@ciq.co>
2023-04-19 20:43:34 -06:00
Jonathon Anderson
bd58ac456c Restore .png files corrupted by #587
Signed-off-by: Jonathon Anderson <janderson@ciq.co>
2023-04-19 20:26:48 -06:00
Christian Goll
321df0ba94 Merge pull request #754 from olafmersmann/fix_el8-pkgs
Add missing packages to build on EL8
2023-03-24 08:24:07 +01:00
Brian Clemens
aa53cf866c Add debugging page to doc index 2023-03-24 10:05:50 +09:00
Olaf Mersmann
b84908b515 Add missing packages to build on EL8
Building on a fresh Rocky Linux 8.7 box gpgme-devel and libassum-devel
in addition to the packages already listed.
2023-03-23 20:26:10 +01:00
Jonathon Anderson
fc362beebc Add a userdocs page for using delve to debug tests
Signed-off-by: Jonathon Anderson <janderson@ciq.co>
2023-03-23 12:57:26 -06:00
Christian Goll
8f76b81596 Merge branch 'development' into genconf 2023-03-22 12:06:58 +01:00
Christian Goll
a935d5fe77 Merge pull request #727 from hpcng/dnsmasq
added experimental dnsmasq support
2023-03-22 12:06:10 +01:00
Jonathon Anderson
6073354d24 Update documentation to reference ghcr rather than DockerHub
Warewulf sample node images are now built automatically with GitHub CI/CD,
targeting ghcr.io. This updates the documentation to reference that location
rather than DockerHub.

Addresses #732

Signed-off-by: Jonathon Anderson <janderson@ciq.co>
2023-03-20 16:09:05 -06:00
Christian Goll
ba0dec021a added experimental dnsmasq support
Signed-off-by: Christian Goll <cgoll@suse.de>
2023-03-10 17:08:01 +01:00
Christian Goll
786ccdb1e1 generate reference documentation
Signed-off-by: Christian Goll <cgoll@suse.de>
2023-03-02 13:52:06 +01:00
Jonathon Anderson
8daa40f929 Update installation.rst 2023-03-01 13:41:02 -07:00
Jonathon Anderson
7fed7fd6a2 Remove reference to deprecated CIQ repository
The CIQ repository mentioned in userdocs is expected to be decommissioned soon.
Meanwhile, we have RPMs on the GitHub releases page. This updates the
documentation to point to the project packages.

Signed-off-by: Jonathon Anderson <janderson@ciq.co>
2023-02-28 15:46:29 -07:00
Jonathon Anderson
e353d021d5 Add a missing hyphen in a documented flag 2023-02-22 01:12:29 -07:00
Jonathon Anderson
10d1edaf81 Fix accidental userdocs italics
Fixes #702

Signed-off-by: Jonathon Anderson <janderson@ciq.co>
2023-02-22 00:58:00 -07:00
Jonathon Anderson
ad25a4349b Console-style code-block and remove sudo
Closes #703 #695

Signed-off-by: Jonathon Anderson <janderson@ciq.co>
2023-02-22 00:41:09 -07:00
Jonathon Anderson
51e84107af Fix code-style dash formatting in userdocs
Closes #704

Signed-off-by: Jonathon Anderson <janderson@ciq.co>
2023-02-22 00:17:12 -07:00
Jonathon Anderson
ef31b3ddb8 Reflow all userdocs text
Signed-off-by: Jonathon Anderson <janderson@ciq.co>
2023-02-22 00:05:36 -07:00
Jonathon Anderson
ed7f817932 Capitalize Warewulf in userdocs where appropriate
Signed-off-by: Jonathon Anderson <janderson@ciq.co>
2023-02-21 09:33:18 -07:00
Jonathon Anderson
656eeea2d6 Completed a copy-editing pass of the docUpdate PR
Signed-off-by: Jonathon Anderson <janderson@ciq.co>
2023-02-21 22:38:25 -07:00
Christian Goll
466d141cf4 reworded the overlay section 2023-02-16 08:59:31 +01:00
Christian Goll
cb06dc8ba0 described syncuser
close #680
close #483
2023-02-15 09:26:57 +01:00
Christian Goll
269db165d3 document --ipmiwrite
close #616
close #643
2023-02-15 08:43:07 +01:00
Christian Goll
d614db5110 updated the configuration to match 4.4.0 features
Signed-off-by: Christian Goll <cgoll@suse.de>
2023-02-14 15:48:06 +01:00
Jonathon Anderson
78b857a3e4 Whitespace cleanup
Removes trailing whitespace from all source files.

Signed-off-by: Jonathon Anderson <janderson@ciq.co>
2022-12-08 18:59:56 -07:00
Brian Clemens
04ee8cc967 feat(docs): New documentation
Convert docs to mkdocs, move back into repo, publish to repo
2022-09-15 21:00:17 +09:00