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

Using Confluence documents as a knowledge source #64

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

makelinux
Copy link

@makelinux makelinux commented May 25, 2024

@makelinux makelinux changed the title confluence design notes Confluence design notes May 25, 2024
@makelinux makelinux changed the title Confluence design notes Confluence document source design notes May 25, 2024
- [ilab utilities module](https://github.com/instructlab/instructlab/blob/main/src/instructlab/utils.py)
fetches documents
- [unit test](https://github.com/instructlab/instructlab/tree/main/tests)

Copy link
Contributor

Choose a reason for hiding this comment

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

In order to support the schema change, ilab, the taxonomy repo (possibly private) and the backend implementation (which does the proper SDG and training from the taxonomy repo) all must agree on the schema so they have a shared understanding of what a qna.yaml file looks like. So it requires coordination between ilab, the backend implementation and the taxonomy repo(s). So making a change in ilab alone is not sufficient.

So this design change will also require support/approval from the backend (SDG) team.

Copy link
Author

Choose a reason for hiding this comment

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

docs/confluence-doc-source.md Outdated Show resolved Hide resolved
docs/confluence-doc-source.md Outdated Show resolved Hide resolved
docs/confluence-doc-source.md Outdated Show resolved Hide resolved
@bjhargrave bjhargrave changed the title Confluence document source design notes Using Confluence documents as a knowledge source May 28, 2024
@leseb
Copy link
Contributor

leseb commented Jun 19, 2024

@makelinux could you please address @bjhargrave's comments so we can move forward? Thanks!

docs/confluence-doc-source.md Outdated Show resolved Hide resolved
Signed-off-by: Costa Shulyupin <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants