mirror of
https://github.com/gogrlx/docs.grlx.dev.git
synced 2026-04-02 03:08:53 -07:00
hugo removal
This commit is contained in:
Ethan Holz
@@ -1,5 +0,0 @@
|
||||
+++
|
||||
title = '{{ replace .File.ContentBaseName "-" " " | title }}'
|
||||
date = {{ .Date }}
|
||||
draft = true
|
||||
+++
|
||||
@@ -1,39 +0,0 @@
|
||||
---
|
||||
title: Overview
|
||||
description: Here's where your user finds out if your project is for them.
|
||||
weight: 1
|
||||
---
|
||||
|
||||
{{% pageinfo %}}
|
||||
This is a placeholder page that shows you how to use this template site.
|
||||
{{% /pageinfo %}}
|
||||
|
||||
|
||||
The Overview is where your users find out about your project. Depending on the size of your docset, you can have a separate overview page (like this one) or put your overview contents in the Documentation landing page (like in the Docsy User Guide).
|
||||
|
||||
Try answering these questions for your user in this page:
|
||||
|
||||
## What is `grlx`?
|
||||
`grlx` is a tool for fleet-level configuration management written in Go.
|
||||
|
||||
## What is it?
|
||||
|
||||
Introduce your project, including what it does or lets you do, why you would use it, and its primary goal (and how it achieves it). This should be similar to your README description, though you can go into a little more detail here if you want.
|
||||
|
||||
## Why do I want it?
|
||||
|
||||
Help your user know if your project will help them. Useful information can include:
|
||||
|
||||
* **What is it good for?**: What types of problems does your project solve? What are the benefits of using it?
|
||||
|
||||
* **What is it not good for?**: For example, point out situations that might intuitively seem suited for your project, but aren't for some reason. Also mention known limitations, scaling issues, or anything else that might let your users know if the project is not for them.
|
||||
|
||||
* **What is it *not yet* good for?**: Highlight any useful features that are coming soon.
|
||||
|
||||
## Where should I go next?
|
||||
|
||||
Give your users next steps from the Overview. For example:
|
||||
|
||||
* [Getting Started](/docs/getting-started/): Get started with $project
|
||||
* [Examples](/docs/examples/): Check out some example code!
|
||||
|
||||
@@ -1,8 +0,0 @@
|
||||
---
|
||||
title: Recipe Ingredients
|
||||
description: The foundation of grlx
|
||||
weight: 1
|
||||
---
|
||||
Recipe ingredients are how we build configurations with `grlx`. They can be thought of as the building blocks for completing various file, service, or management operations.
|
||||
|
||||
## Components
|
||||
@@ -1,68 +0,0 @@
|
||||
---
|
||||
title: grlx.ingredients.file
|
||||
---
|
||||
## **file.absent**
|
||||
Deletes a file or directory
|
||||
##### Parameters
|
||||
* _name_ (string,required): the name/path of the file to delete
|
||||
##### Example
|
||||
```yaml
|
||||
file.absent:
|
||||
name: ~/.config/sytemd/user/backup.service
|
||||
```
|
||||
|
||||
## **file.append**
|
||||
Appends content to a file. Only appends the content if it doesn't exist.
|
||||
#### Parameters
|
||||
* _name_ (string,required): the name/path of the file to delete
|
||||
* _text_ (string,required): the text to append to a file
|
||||
#### Example
|
||||
```yaml
|
||||
file.append:
|
||||
- name: /etc/profile
|
||||
- text: |
|
||||
export PATH=$PATH:/usr/local/go/bin
|
||||
```
|
||||
|
||||
## **file.contains**
|
||||
Checks if a file contains a given selection. If multiple sources are provided, all must be satisfied.
|
||||
#### Parameters
|
||||
* _name_ (string,required): the name/path of the file to check
|
||||
* _text_ (string): the item to search for
|
||||
* _source_ (string): a file source (such as HTTP, file, etc.) to reference
|
||||
* _source_hash_ (string): a hash for a given source
|
||||
* _sources_ (list): a list of sources to check against
|
||||
* _source_hashes_ (list): a list of source hashes
|
||||
* _skip_verify_ (boolean): whether to skip hash validation, false by default
|
||||
|
||||
|
||||
## **file.directory**
|
||||
Handles many directory operations. Ensures that a directory exists with the given permissions.
|
||||
#### Parameters
|
||||
* _name_ (string,required): the name/path of the directory
|
||||
* _makedirs_ (bool): option to make directory if it doesn't exist, defaults to true
|
||||
* _user_ (string): the user who will own the directory
|
||||
* _group_ (string): the group who will own the directory
|
||||
* _dir_mode_ (string): the directory mode
|
||||
* _file_mode_ (string): the file mode to set
|
||||
* _recurse_ (bool): whether to recurse the directories and apply permissions
|
||||
|
||||
## **file.exists**
|
||||
Checks if a file exists.
|
||||
#### Parameters
|
||||
* _name_ (string,required): the name/path of the file
|
||||
#### Examples
|
||||
```yaml
|
||||
file.exists:
|
||||
- name: /tmp/exists
|
||||
```
|
||||
|
||||
## **file.missing**
|
||||
Checks if a file is missing.
|
||||
#### Parameters
|
||||
* _name_ (string,required): the name/path of the file
|
||||
#### Examples
|
||||
```yaml
|
||||
file.missing:
|
||||
- name: /tmp/missing
|
||||
```
|
||||
@@ -1,29 +0,0 @@
|
||||
---
|
||||
title: Documentation
|
||||
linkTitle: Docs
|
||||
menu: {main: {weight: 20}}
|
||||
weight: 20
|
||||
---
|
||||
|
||||
{{% pageinfo %}}
|
||||
This is a placeholder page that shows you how to use this template site.
|
||||
{{% /pageinfo %}}
|
||||
|
||||
This section is where the user documentation for your project lives - all the
|
||||
information your users need to understand and successfully use your project.
|
||||
|
||||
For large documentation sets we recommend adding content under the headings in
|
||||
this section, though if some or all of them don’t apply to your project feel
|
||||
free to remove them or add your own. You can see an example of a smaller Docsy
|
||||
documentation site in the [Docsy User Guide](https://docsy.dev/docs/), which
|
||||
lives in the [Docsy theme
|
||||
repo](https://github.com/google/docsy/tree/master/userguide) if you'd like to
|
||||
copy its docs section.
|
||||
|
||||
Other content such as marketing material, case studies, and community updates
|
||||
should live in the [About](/about/) and [Community](/community/) pages.
|
||||
|
||||
Find out how to use the Docsy theme in the [Docsy User
|
||||
Guide](https://docsy.dev/docs/). You can learn more about how to organize your
|
||||
documentation (and how we organized this site) in [Organizing Your
|
||||
Content](https://docsy.dev/docs/best-practices/organizing-content/).
|
||||
5
go.mod
5
go.mod
@@ -1,5 +0,0 @@
|
||||
module github.com/gogrlx/docs.grlx.dev
|
||||
|
||||
go 1.21.3
|
||||
|
||||
require github.com/google/docsy v0.7.1 // indirect
|
||||
5
go.sum
5
go.sum
@@ -1,5 +0,0 @@
|
||||
github.com/FortAwesome/Font-Awesome v0.0.0-20230327165841-0698449d50f2/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo=
|
||||
github.com/google/docsy v0.7.1 h1:DUriA7Nr3lJjNi9Ulev1SfiG1sUYmvyDeU4nTp7uDxY=
|
||||
github.com/google/docsy v0.7.1/go.mod h1:JCmE+c+izhE0Rvzv3y+AzHhz1KdwlA9Oj5YBMklJcfc=
|
||||
github.com/google/docsy/dependencies v0.7.1/go.mod h1:gihhs5gmgeO+wuoay4FwOzob+jYJVyQbNaQOh788lD4=
|
||||
github.com/twbs/bootstrap v5.2.3+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0=
|
||||
28
hugo.toml
28
hugo.toml
@@ -1,28 +0,0 @@
|
||||
baseURL = 'https://example.org/'
|
||||
languageCode = 'en-us'
|
||||
title = 'grlx.dev'
|
||||
[module]
|
||||
proxy = "direct"
|
||||
[[module.imports]]
|
||||
path = "github.com/google/docsy"
|
||||
[[module.imports]]
|
||||
path = "github.com/google/docsy/dependencies"
|
||||
[markup]
|
||||
[markup.goldmark]
|
||||
[markup.goldmark.renderer]
|
||||
unsafe = true
|
||||
[markup.highlight]
|
||||
# See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html
|
||||
style = "catppuccin-latte"
|
||||
[params.ui]
|
||||
sidebar_menu_foldable = true
|
||||
[[params.links.user]]
|
||||
name ="Twitter"
|
||||
url = "https://x.com/gogrlx"
|
||||
icon = "fab fa-twitter"
|
||||
desc = "Follow us on Twitter to get the latest news!"
|
||||
[[params.links.user]]
|
||||
name = "GitHub"
|
||||
url = "https://github.com/gogrlx/grlx"
|
||||
icon = "fab fa-github"
|
||||
desc = "Development takes place here!"
|
||||
Reference in New Issue
Block a user