Skip to content

Commit 782c4fa

Browse files
DO! DevOps botDennis Ploeger
authored andcommitted
docs: Automatic docs update
1 parent 9c84998 commit 782c4fa

1 file changed

Lines changed: 23 additions & 2 deletions

File tree

README.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ 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
1920
* 🐟 Fish Shell
2021
* 📷 AzCopy
2122
* 🪪 Certificates
@@ -51,6 +52,7 @@ Following features and tools are supported:
5152
* [simple](#simple)
5253
* [tanzu](#tanzu)
5354
* [Features](#features)
55+
* [Direnv](#.template)
5456
* [Fish Shell](#_fish)
5557
* [AzCopy](#azcopy)
5658
* [Certificates](#certificates)
@@ -359,6 +361,15 @@ The kubernetes login tokens usually expire after a few hours already. You can ru
359361
does.
360362

361363
## 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+
362373
### <a id="_fish"></a> Fish Shell
363374

364375
Installs and configures the [Fish Shell](https://fishshell.com/) with configured [Spacefish theme](https://spacefish.matchai.me/)
@@ -643,14 +654,24 @@ Installs the [YAML parser and processor yq](https://github.com/mikefarah/yq)
643654

644655
## Development
645656

646-
*CloudControl* supports a decoupled development of features and flavours. If you're missing something, just fork this
647-
repository, create a subfolder for your new feature under "features" and add these files:
657+
*CloudControl* supports a decoupled development of features and flavours.
658+
659+
### Features
660+
661+
If you're missing a feature, just fork this repository, copy the feature template from features/.template into a
662+
new subfolder, check out the comments in the example files, and modify them to your needs.
663+
664+
These files make up a feature:
648665

649666
* `feature.yaml`: A descriptor for your feature with a title, a description and configuration notes
650667
* `install.sh`: A shell script that is run by CloudControlCenter and should install everything you need
651668
for your new feature
652669
* `motd.sh`: (optional) If you want to show some information to the users upon login, put them here.
653670

671+
And an optional, but recommended `.goss` folder for [integration testing](#integration-testing).
672+
673+
### Flavours
674+
654675
If you need another flavour (aka cloud provider), add a new subdirectory under "flavour" and add a flavour.yaml describing
655676
your flavour the same way as a feature. For the rest of the files, please check out existing flavours for details. Please,
656677
include a sample configuration for your flavour to make it easier for other people to work with it.

0 commit comments

Comments
 (0)