-
Notifications
You must be signed in to change notification settings - Fork 323
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
import confluence documents #1160
Conversation
637b946
to
e0e212d
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.
Thank you!
The lint failures are going to be fixed by #1162.
a1cac92
to
87ebdd8
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.
I placed a hold
since this should depend on backend support, as well.
As for these changes, I think it would be nice to consider making this an optional dependency, since it would not be part of the most common flow.
There is also the issue of knowledge stability. In the current git-repo-with-knowledge, a commit SHA is provided so the knowledge can be reliably collected at SDG/training time which matches the contribution time. This is important. The example here of using confluence do not seem to have a way to pin the knowledge to a specific revision like git does with a commit SHA. So I think this is a concern for repeatability and safety (since the knowledge could be poisoned after the contribution is made but before the SDG and training are done). |
Adding a new knowledge source seems like a good candidate for a design doc in the |
I've added Confluence versioning. |
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.
@makelinux What would a functional test for this look like? Thanks!
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.
Thanks @makelinux for pushing this capability. As @russellb mentioned in #1160 (comment), do you mins pushing a design doc for this capability?
Hi, @russellb , @hickeyma, here is the requested document Confluence document source design notes |
|
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.
Small nits otherwise this feels ready to go.
Depends on updated schema. Test with pytest -k test_get_confluence_docs Signed-off-by: Costa Shulyupin <[email protected]>
I mean if there's an expectation that we would accept any PRs into I see a design doc is up now (thank you!) so let's also get that merged first -- instructlab/dev-docs#64 |
The rub is that ilab command and the public taxonomy repo share the same schema (from the schema repo). So to add this PR in ilab would require a schema update which would also be then in the public taxonomy repo which means people can submit such qna.yaml files which would not fail schema validation. Otherwise we would need to diverge on the schema such that ilab uses an superset schema than the public taxonomy repo. But even this can create disharmony since people could develop a qna.yaml which |
This pull request has been automatically marked as stale because it has not had activity within 90 days. It will be automatically closed if no further activity occurs within 30 days. |
This pull request has merge conflicts that must be resolved before it can be |
yaml example:
Closes #1152
Depends on: instructlab/schema#17