Put text descriptions next to yaml examples
Maintainers usually reply within 1 day
@mrbojangles3 is already working on this.
Since Apr 15, 2025.
Assessment
This issue has not been assessed yet.
Description
When a customer is building a yaml file or referencing a part of the docs, eg VPC remote peering, the description and the yaml should be in the same section.
- Dominant language
- Just
- Stars
- 6
- Forks
- 12
- Avg merge
- 18h 48m
- Merged PRs (30d)
- 9
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
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.
More from githedgehog/docs
-
Difficulty 1/5 1-3 hours Newbie friendliness 85/100
githedgehog/docs#341 ·
Maintainers usually reply within 1 day
-
VM ctrl/gw recommendations: xcp-ngMay be free again @mrbojangles3 claimed this 86 days ago, and no pull request is open. Open
githedgehog/docs#326 · 1 assignee ·
Maintainers usually reply within 1 day
-
Evaluate New Docs FrameworkMay be free again @mrbojangles3 claimed this 111 days ago, and no pull request is open. Open
githedgehog/docs#315 · 2 comments · 1 assignee ·
Maintainers usually reply within 1 day
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
githedgehog/docs#309 ·
Maintainers usually reply within 1 day
-
Add section on Gateway peering with NAT externalsMay be free again @mrbojangles3 claimed this 324 days ago, and no pull request is open. Opendocumentation
githedgehog/docs#218 · 1 assignee ·
Maintainers usually reply within 1 day