mia-platform / mia-platform/mlp

[Docs]: generate Command - Unclear how to set the "file" value for secrets from file

Open
#84 1 comment 0 reactions 0 assignees View on GitHub
documentation needs triage
Dominant language
Go
Stars
10
Forks
3
PR merge metrics
No merged PRs in 30d

Description

### Documentation Revision

Hi guys,
I read on [this page](https://github.com/mia-platform/mlp/blob/main/docs/40_generate.md) I can read the secret content from literal or **from file**.
Regarding the **from file** case, I am not sure about what value should I use for the `file` property.

Are the following examples right?
```
secrets:
- name: "my-secret-value-from-local-file"
when: "always"
data:
- from: "file"
file: ./path-to-file-in-same-repository

- name: "my-secret-value-from-file-on-git-provider"
when: "always"
data:
- from: "file"
file: /path/to/same/git/provider/repository/file
```

Is there any other use case I am missing?

### Code of Conduct

- [X] I agree to follow this project’s Code of Conduct

Contributor guide

Open the contributing guide

Research direction

Start by reading docs/40_generate.md and the generate-command documentation around secrets and the file property. Confirm the supported path sources and examples, then update the page so readers can distinguish valid local or provider paths and know what value to use.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.