Incomplete documentation for [[services.http_checks]] section
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 52/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- html
- Domain
- documentation
Research direction
Read reference/configuration.html.markerb and locate the [[services.http_checks]] example and surrounding [[services]] and [[http_service]] guidance. Clarify where the section belongs and how it relates to the configured internal port, then verify the rendered configuration documentation explains the placement unambiguously.
Written by the indexing model from the issue text.
Description
I found an issue with this document.
Title: App configuration (fly.toml)
Location: https://fly.io/docs/reference/configuration/
Source: https://github.com/superfly/docs/blob/main/reference/configuration.html.markerb
Describe the issue
The document provides example of the [[services.http_checks]] section, however it does not indicate where this section should be placed.
When placed at the top level of the fly.toml, which is most logical for those new to TOML, the http checks goes against port 8080, ignoring any custom internal port that may have been configured under the[[http_service]] section. I discovered that in order to go against the correct port, the [[services.http_checks]] needs to be placed under the [[services]] section that has defined the internal port.
This is an opportunity to improve the documentation.
- Dominant language
- HTML
- Stars
- 128
- Forks
- 1.1k
- Avg merge
- 4d 15h
- Merged PRs (30d)
- 12
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.
More from superfly/docs
-
Difficulty 1/5 Under an hour Newbie friendliness 68/100
-
Difficulty 1/5 Under an hour Newbie friendliness 65/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
-
feature
Difficulty 3/5 1-2 days Newbie friendliness 55/100
-
Difficulty 3/5 1-2 days Newbie friendliness 62/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
bancolombia/sentinel#22 ·
-
test md OpenCI
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
optimization optimization:agents-md-curator
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
githubnext/gh-aw-cao#13143 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 94/100
objectionary/hone-maven-plugin#1061 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
redhat-developer/rhdh-plugins#4887 · 2 comments ·