Fix documentation (broken partial rendering and missing id) #4862
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As I used the service registration doc I stumbled upon a few errors, which I try to address here:
Broken partial rendering for service (de)registration (CLI)
Problematic pages:
Both pages include a partial for the API options, but the current version doesn't render this partial:
Current live website capture:
The fix is simple (but took me a while since I'm new to middleman), and it really comes down to renaming those files so that the partials are evaluated and not just outputted as raw content.
Here's a sample of the local test as I verified the fix:
Incomplete JSON sample for the service registration
Page: https://www.consul.io/docs/agent/services.html
Two small issues here:
connect
block (nothing a user wouldn't be able to fix after copying the template, but I believe having a template ready to be customized rather than fixed is nice)the other point is really nitpicking, but the template is preceded by (emphasis mine)
So the template is supposed to be complete, and the very first field described is the
id
field, but this field is not present in the template?!In this PR I added the field to remove any confusion or "oh wait, did I missed something?" moment for the future reader.