Skip to content

Commit ac7b3e4

Browse files
dploegerDennis Ploeger
authored andcommitted
fix: Remove template from doc generation
1 parent 2ea77f6 commit ac7b3e4

3 files changed

Lines changed: 10 additions & 14 deletions

File tree

README.md

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ Currently supported cloud flavours are:
1616
* [Tanzu](https://github.com/dodevops/cloudcontrol/pkgs/container/cloudcontrol-tanzu) (based on [alpine](https://hub.docker.com/_/alpine)) [linux/amd64]
1717

1818
Following features and tools are supported:
19-
* ⚙️ Direnv
2019
* 🐟 Fish Shell
2120
* 📷 AzCopy
2221
* 🪪 Certificates
@@ -52,7 +51,6 @@ Following features and tools are supported:
5251
* [simple](#simple)
5352
* [tanzu](#tanzu)
5453
* [Features](#features)
55-
* [Direnv](#.template)
5654
* [Fish Shell](#_fish)
5755
* [AzCopy](#azcopy)
5856
* [Certificates](#certificates)
@@ -361,15 +359,6 @@ The kubernetes login tokens usually expire after a few hours already. You can ru
361359
does.
362360

363361
## Features
364-
### <a id=".template"></a> Direnv
365-
366-
Installs [Direnv](https://direnv.net/)
367-
368-
#### Configuration
369-
370-
* USE_.template: Enable this feature
371-
* DEBUG_.template: Debug this feature
372-
373362
### <a id="_fish"></a> Fish Shell
374363

375364
Installs and configures the [Fish Shell](https://fishshell.com/) with configured [Spacefish theme](https://spacefish.matchai.me/)
@@ -833,3 +822,7 @@ flowchart TD
833822
click F "https://github.com/dodevops/cloudcontrol/blob/develop/.github/workflows/test.yml" "Test workflow"
834823
click H "https://github.com/dodevops/cloudcontrol/blob/develop/.github/workflows/release.yml" "Release workflow"
835824
```mermaid
825+
vops/cloudcontrol/blob/develop/.github/workflows/test.yml" "Test workflow"
826+
click H "https://github.com/dodevops/cloudcontrol/blob/develop/.github/workflows/release.yml" "Release workflow"
827+
```mermaid
828+
```mermaid

cmd/doc/mkdoc.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@ func fetchDocData(basePath string, filenamePattern string) (map[string]internal.
2323
return docDatas, err
2424
} else {
2525
for _, dir := range subDirs {
26+
if filepath.Base(dir) == ".template" {
27+
continue
28+
}
2629
if _, err := os.Stat(filepath.Join(dir, filenamePattern)); err == nil {
2730
if yamlFile, err := os.ReadFile(filepath.Join(dir, filenamePattern)); err != nil {
2831
return docDatas, err

feature/.template/feature.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22
# In your new feature, please remove all descriptive comments from the template.
33

44
# Please use an emoji character as a meaningful logo for your feature
5-
icon: "⚙️"
5+
icon: "🫥"
66

77
# Set the title for this feature
8-
title: "Direnv"
8+
title: "Template"
99

1010
# Set the description of the feature in Markdown. Be sure to include links to websites of the software the feature
1111
# installs or configures
12-
description: "Installs [Direnv](https://direnv.net/)"
12+
description: "Does some awesome stuff"
1313

1414
# Use the configuration key to list additional configuration options that you're providing in your feature
1515
configuration:

0 commit comments

Comments
 (0)