Skip to content

Commit

Permalink
Update main docs
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Jan 31, 2025
1 parent 7cebb9b commit 3324ab9
Show file tree
Hide file tree
Showing 147 changed files with 147 additions and 148 deletions.
3 changes: 1 addition & 2 deletions static/docs/main/_sources/contributing/contributing.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@ Warewulf on Slack
Many members of the Warewulf community, including developers, communicate via Slack.
It's a great place to get help with an issue or talk about how you're using Warewulf.

`Join the Warewulf Slack Workspace!
<https://join.slack.com/t/warewulf/shared_invite/zt-27moxdo1x-f1ztmeUU5OgmVtdwJVH9Xg>`_
An invite link is available at `https://warewulf.org/help/ <https://warewulf.org/help/>`.

Raise an Issue
==============
Expand Down
2 changes: 1 addition & 1 deletion static/docs/main/_sources/reference/wwctl.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ SEE ALSO
* :ref:`wwctl upgrade <wwctl_upgrade>` - Upgrade configuration files
* :ref:`wwctl version <wwctl_version>` - Version information

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
2 changes: 1 addition & 1 deletion static/docs/main/_sources/reference/wwctl_clean.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ SEE ALSO

* :ref:`wwctl <wwctl>` - Warewulf Control

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ SEE ALSO
* :ref:`wwctl completion powershell <wwctl_completion_powershell>` - Generate the autocompletion script for powershell
* :ref:`wwctl completion zsh <wwctl_completion_zsh>` - Generate the autocompletion script for zsh

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -57,4 +57,4 @@ SEE ALSO

* :ref:`wwctl completion <wwctl_completion>` - Generate the autocompletion script for the specified shell

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,4 @@ SEE ALSO

* :ref:`wwctl completion <wwctl_completion>` - Generate the autocompletion script for the specified shell

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,4 @@ SEE ALSO

* :ref:`wwctl completion <wwctl_completion>` - Generate the autocompletion script for the specified shell

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -59,4 +59,4 @@ SEE ALSO

* :ref:`wwctl completion <wwctl_completion>` - Generate the autocompletion script for the specified shell

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ SEE ALSO
* :ref:`wwctl configure ssh <wwctl_configure_ssh>` - Manage and initialize SSH
* :ref:`wwctl configure tftp <wwctl_configure_tftp>` - Manage and initialize TFTP

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ SEE ALSO

* :ref:`wwctl configure <wwctl_configure>` - Manage system services

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ SEE ALSO

* :ref:`wwctl configure <wwctl_configure>` - Manage system services

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ SEE ALSO

* :ref:`wwctl configure <wwctl_configure>` - Manage system services

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ SEE ALSO

* :ref:`wwctl configure <wwctl_configure>` - Manage system services

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ SEE ALSO

* :ref:`wwctl configure <wwctl_configure>` - Manage system services

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ SEE ALSO
* :ref:`wwctl genconfig reference <wwctl_genconfig_reference>` - reference generation
* :ref:`wwctl genconfig warewulfconf <wwctl_genconfig_warewulfconf>` - access warewulf.conf

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ SEE ALSO

* :ref:`wwctl genconfig <wwctl_genconfig>` - Generate various configurations

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ SEE ALSO

* :ref:`wwctl genconfig <wwctl_genconfig>` - Generate various configurations

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ SEE ALSO

* :ref:`wwctl genconfig <wwctl_genconfig>` - Generate various configurations

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ SEE ALSO
* :ref:`wwctl genconfig <wwctl_genconfig>` - Generate various configurations
* :ref:`wwctl genconfig warewulfconf print <wwctl_genconfig_warewulfconf_print>` - print wareweulf.conf

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ SEE ALSO

* :ref:`wwctl genconfig warewulfconf <wwctl_genconfig_warewulfconf>` - access warewulf.conf

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
2 changes: 1 addition & 1 deletion static/docs/main/_sources/reference/wwctl_image.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,4 @@ SEE ALSO
* :ref:`wwctl image show <wwctl_image_show>` - Show root fs dir for image
* :ref:`wwctl image syncuser <wwctl_image_syncuser>` - Synchronizes user in image

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ SEE ALSO

* :ref:`wwctl image <wwctl_image>` - Operating system image management

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ SEE ALSO

* :ref:`wwctl image <wwctl_image>` - Operating system image management

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ SEE ALSO

* :ref:`wwctl image <wwctl_image>` - Operating system image management

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,4 @@ SEE ALSO

* :ref:`wwctl image <wwctl_image>` - Operating system image management

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -59,4 +59,4 @@ SEE ALSO

* :ref:`wwctl image <wwctl_image>` - Operating system image management

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ SEE ALSO

* :ref:`wwctl image <wwctl_image>` - Operating system image management

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,4 @@ SEE ALSO

* :ref:`wwctl image <wwctl_image>` - Operating system image management

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ SEE ALSO

* :ref:`wwctl image <wwctl_image>` - Operating system image management

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,4 @@ SEE ALSO

* :ref:`wwctl image <wwctl_image>` - Operating system image management

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ SEE ALSO

* :ref:`wwctl image <wwctl_image>` - Operating system image management

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ SEE ALSO

* :ref:`wwctl image <wwctl_image>` - Operating system image management

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
2 changes: 1 addition & 1 deletion static/docs/main/_sources/reference/wwctl_node.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,4 @@ SEE ALSO
* :ref:`wwctl node set <wwctl_node_set>` - Configure node properties
* :ref:`wwctl node status <wwctl_node_status>` - View the provisioning status of nodes

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
2 changes: 1 addition & 1 deletion static/docs/main/_sources/reference/wwctl_node_add.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -83,4 +83,4 @@ SEE ALSO

* :ref:`wwctl node <wwctl_node>` - Node management

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ SEE ALSO

* :ref:`wwctl node <wwctl_node>` - Node management

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ SEE ALSO

* :ref:`wwctl node <wwctl_node>` - Node management

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ SEE ALSO

* :ref:`wwctl node <wwctl_node>` - Node management

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ SEE ALSO

* :ref:`wwctl node <wwctl_node>` - Node management

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ SEE ALSO

* :ref:`wwctl node <wwctl_node>` - Node management

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ SEE ALSO

* :ref:`wwctl node <wwctl_node>` - Node management

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ SEE ALSO

* :ref:`wwctl node <wwctl_node>` - Node management

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
2 changes: 1 addition & 1 deletion static/docs/main/_sources/reference/wwctl_node_set.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -95,4 +95,4 @@ SEE ALSO

* :ref:`wwctl node <wwctl_node>` - Node management

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ SEE ALSO

* :ref:`wwctl node <wwctl_node>` - Node management

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
2 changes: 1 addition & 1 deletion static/docs/main/_sources/reference/wwctl_overlay.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ SEE ALSO
* :ref:`wwctl overlay mkdir <wwctl_overlay_mkdir>` - Create a new directory within an Overlay
* :ref:`wwctl overlay show <wwctl_overlay_show>` - Show (cat) a file within a Warewulf Overlay

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ SEE ALSO

* :ref:`wwctl overlay <wwctl_overlay>` - Warewulf Overlay Management

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,4 @@ SEE ALSO

* :ref:`wwctl overlay <wwctl_overlay>` - Warewulf Overlay Management

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ SEE ALSO

* :ref:`wwctl overlay <wwctl_overlay>` - Warewulf Overlay Management

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ SEE ALSO

* :ref:`wwctl overlay <wwctl_overlay>` - Warewulf Overlay Management

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ SEE ALSO

* :ref:`wwctl overlay <wwctl_overlay>` - Warewulf Overlay Management

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ SEE ALSO

* :ref:`wwctl overlay <wwctl_overlay>` - Warewulf Overlay Management

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ SEE ALSO

* :ref:`wwctl overlay <wwctl_overlay>` - Warewulf Overlay Management

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ SEE ALSO

* :ref:`wwctl overlay <wwctl_overlay>` - Warewulf Overlay Management

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ SEE ALSO

* :ref:`wwctl overlay <wwctl_overlay>` - Warewulf Overlay Management

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ SEE ALSO

* :ref:`wwctl overlay <wwctl_overlay>` - Warewulf Overlay Management

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
2 changes: 1 addition & 1 deletion static/docs/main/_sources/reference/wwctl_power.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ SEE ALSO
* :ref:`wwctl power soft <wwctl_power_soft>` - Gracefully shuts down the given node(s)
* :ref:`wwctl power status <wwctl_power_status>` - Show power status for the given node(s)

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ SEE ALSO

* :ref:`wwctl power <wwctl_power>` - Warewulf node power management

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ SEE ALSO

* :ref:`wwctl power <wwctl_power>` - Warewulf node power management

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
2 changes: 1 addition & 1 deletion static/docs/main/_sources/reference/wwctl_power_on.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ SEE ALSO

* :ref:`wwctl power <wwctl_power>` - Warewulf node power management

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ SEE ALSO

* :ref:`wwctl power <wwctl_power>` - Warewulf node power management

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ SEE ALSO

* :ref:`wwctl power <wwctl_power>` - Warewulf node power management

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ SEE ALSO

* :ref:`wwctl power <wwctl_power>` - Warewulf node power management

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
2 changes: 1 addition & 1 deletion static/docs/main/_sources/reference/wwctl_profile.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ SEE ALSO
* :ref:`wwctl profile list <wwctl_profile_list>` - List profiles and configurations
* :ref:`wwctl profile set <wwctl_profile_set>` - Configure node profile properties

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -81,4 +81,4 @@ SEE ALSO

* :ref:`wwctl profile <wwctl_profile>` - Node configuration profile management

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ SEE ALSO

* :ref:`wwctl profile <wwctl_profile>` - Node configuration profile management

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ SEE ALSO

* :ref:`wwctl profile <wwctl_profile>` - Node configuration profile management

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ SEE ALSO

* :ref:`wwctl profile <wwctl_profile>` - Node configuration profile management

*Auto generated by spf13/cobra on 29-Jan-2025*
*Auto generated by spf13/cobra on 31-Jan-2025*
Loading

0 comments on commit 3324ab9

Please sign in to comment.