Generate service docs from Go files #390
Open
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.
There have been some talks of adding configuration examples in the source files, so I figured I'd make them machine-readable and integrate them with Jekyll.
This PR adds a script that can parse descriptions from service files and output them as a JSON file, which can then be used in Jekyll to generate the documentation files.
Example usage:
I added a quick example of the metadata in redis.go; it shouldn't take much to do the same for all services.