pomerium / pomerium/documentation
Feature request: filter settings reference table by config file key or environment variable name
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 13
- Forks
- 23
- Avg merge
- 1d 5h
- Merged PRs (30d)
- 11
Description
Page: https://www.pomerium.com/docs/reference
What's incorrect or missing
The data table on the 'Configuration & Settings Reference' page lists settings by name. However these names sometimes differ from the config file or environment variable name. If I know a config file key and want to search for the documentation for it, I can't easily filter the table to find a link to that corresponding reference page.
Or maybe I'd like to see a list of all settings ending in _file. Currently it doesn't appear to be possible to filter for this using the table.
What's the resolution?
Is there some way we can allow searching through the table by config file key and/or environment variable name?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Configuration & Settings Reference page and inspect how its data table is generated and filtered. Verify whether config file keys and environment variable names are available in the table data, then make the table searchable by those fields and confirm that key fragments such as _file return the expected settings.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100