Skip to content
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

doc: expand on language pack documentation #545

Closed
wants to merge 1 commit into from

Conversation

lance
Copy link
Member

@lance lance commented Sep 20, 2021

Changes

Adds more detail around how language packs can be provided by third parties, and the expected structure and metadata required. Creating as WIP pending additional discussion and possible implementation of #452

/kind documentation

Fixes: #452

Adds more detail around how language packs can be provided by third
parties, and the expected structure and metadata required.

Fixes: knative#452

Signed-off-by: Lance Ball <lball@redhat.com>
@knative-prow-robot
Copy link

[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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@google-cla google-cla bot added the cla: yes Indicates the PR's author has signed the CLA. label Sep 20, 2021
@knative-prow-robot knative-prow-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Sep 20, 2021
└── test.rb
```

## `manifest.yaml`
Copy link
Member

@lkingland lkingland Sep 20, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought that manifest.yaml would be placed at the Language Pack Repository Root. Basically, at the URL which is provided to func repository add. If func searches for a manifest.yaml at that URL (the repository's manifest), then the developer of the Language Pack would be free to place all their runtimes in a subdirectory. Are we talking about the same manifest.yaml? The above seems like it might be for a single template specifically?

Regardig a repo-root manifest, we could look for a manifest.yaml at URL provided to func repo add, and within that manifest look for a 'templates: <path>' entry which specifies a repository-relative path to use for runtimes/templates as an override to the default behavior of using file structure. To make things even easier, we could automatically use a directory 'templates' if that exists.

@lance lance marked this pull request as draft September 21, 2021 13:43
@knative-prow-robot knative-prow-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Sep 21, 2021
@lance
Copy link
Member Author

lance commented Sep 30, 2021

Closing this. Changes here have been copied to #558 and updated.

@lance lance closed this Sep 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cla: yes Indicates the PR's author has signed the CLA. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. kind/documentation size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Determine and document expected directory structure for language pack extensions
3 participants