From 28d6f8700e00ec9035486e9ffc5b10aef447f836 Mon Sep 17 00:00:00 2001 From: JJ Asghar Date: Mon, 19 Aug 2024 16:33:44 -0500 Subject: [PATCH] Update knowledge-contribution-guide.md Updated from the e2e-ready to community-build-ready label. Signed-off-by: JJ Asghar --- docs/knowledge-contribution-guide.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/knowledge-contribution-guide.md b/docs/knowledge-contribution-guide.md index a43ecb295..4fd919176 100644 --- a/docs/knowledge-contribution-guide.md +++ b/docs/knowledge-contribution-guide.md @@ -36,7 +36,7 @@ The specific steps are listed as follows: 3. You can then see your new content in your repository. > [!IMPORTANT] - > Make a note of your commit SHA, you need it for your `qna.yaml`. + > Make a note of your commit SHA; you need it for your `qna.yaml`. ## Create a pull request in the taxonomy repository @@ -49,15 +49,15 @@ There are a few ways you can create a pull request: ## Verification -A few things to check before seeking reviews for your contribution: +Here are a few things to check before seeking reviews for your contribution: - Your `qna.yaml` follows the proper formatting. See examples in [Knowledge: YAML examples](https://github.com/instructlab/taxonomy/blob/main/README.md#knowledge-yaml-examples) - Ensure all parameters are set. Especially the `document`, `repo`, `commit` and `pattern` keys; these parameters are specific to knowledge contributions and require more analysis. -- Include a `attribution.txt` file for citing your sources. see [For your attribution.txt file](https://github.com/instructlab/taxonomy/blob/main/CONTRIBUTING.md#for-your-attributiontxt-file) for more information. +- Include an `attribution.txt` file for citing your sources. see [For your attribution.txt file](https://github.com/instructlab/taxonomy/blob/main/CONTRIBUTING.md#for-your-attributiontxt-file) for more information. ## PR Upstream Workflow -This following table outlines the expected timing for the PR(s) you have put in. The PRs go through a few steps, and checks, but you should be able to map your `label` to +The following table outlines the expected timing for the PR(s) you have put in. The PRs go through a few steps, and checks, but you should be able to map your `label` to the place that it is in. | Label | Actor | Action | Duration | @@ -67,5 +67,5 @@ the place that it is in. | https://github.com/instructlab/taxonomy/labels/triage-needed | Triager | Review PR, ask for changes | Days | | https://github.com/instructlab/taxonomy/labels/triage-requested-changes | Contributor | Make requested changes | Days | | https://github.com/instructlab/taxonomy/labels/precheck-generate-ready | Triager | Run prechecks and generate | Days | -| https://github.com/instructlab/taxonomy/labels/e2e-ready | Backend | Model gets retrained | Weeks | +| https://github.com/instructlab/taxonomy/labels/community-build-ready | Backend | Model gets retrained | Weeks | | | Triager | Check the numbers and PR merged or closed | - |