-
Notifications
You must be signed in to change notification settings - Fork 130
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: add a language pack "contract" document #918
docs: add a language pack "contract" document #918
Conversation
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: lance The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Codecov Report
@@ Coverage Diff @@
## main #918 +/- ##
==========================================
+ Coverage 43.85% 45.83% +1.98%
==========================================
Files 55 57 +2
Lines 5163 7442 +2279
==========================================
+ Hits 2264 3411 +1147
- Misses 2576 3703 +1127
- Partials 323 328 +5
Continue to review full report at Codecov.
|
|
6fb4d47
to
837fb60
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hugely beneficial addition! All I could come up with was a bunch of minor syntactic nits.
👍🏻
/hold for others
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: lance, lkingland The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
The docs/guides/langugage-packs.md document does a good job of describing what's required of a language pack in terms of directory structure and the options for the `manifest.yaml` file. But it does a pretty crappy job of describing the whole thing in context. I've tried to do that here. Also some fixes to links and reorganization of the docs to make things a little easier to find. Signed-off-by: Lance Ball <lball@redhat.com>
Signed-off-by: Lance Ball <lball@redhat.com>
f5ce1d6
to
5991cc5
Compare
Signed-off-by: Lance Ball <lball@redhat.com>
@lkingland thanks for the thorough review. I've incorporated your feedback, with a couple of replies to your comments above. I've also inlined the language pack reference as suggested. It is mostly a copy/paste, but I did tweak some of the wording here and there to try and make things clearer. PTAL |
Signed-off-by: Lance Ball <lball@redhat.com>
/lgtm |
/unhold |
Rendered version: https://github.com/lance/func/blob/lance/add-language-pack-contract/docs/language-pack-providers/language-pack-contract.md
The docs/guides/langugage-packs.md document does a good job of describing what's required of a language pack in terms of directory structure and the options for the
manifest.yaml
file. But it does a pretty crappy job of describing the whole thing in context. I've tried to do that here.Also some fixes to links and reorganization of the docs to make things a little easier to find.
Fixes: #574 (maybe?)
Signed-off-by: Lance Ball lball@redhat.com