Skip to content

Automate file uploading to a common knowledge documents repo#6

Merged
vishnoianil merged 2 commits intoinstructlab:mainfrom
nerdalert:file-uploading
Jun 20, 2024
Merged

Automate file uploading to a common knowledge documents repo#6
vishnoianil merged 2 commits intoinstructlab:mainfrom
nerdalert:file-uploading

Conversation

@nerdalert
Copy link
Member

@nerdalert nerdalert commented Jun 17, 2024 •
edited
Loading

  • Adds a drag-and-drop file upload (PDF, Markdown)
  • Creates a signed PR with user uploaded documents into a forked upstream template docs repo and captures the commit SHA that is maintained with a merge commit. The SHA and file names are then populated back into the knowledge submission form.

Tracked by #4

  • Workflow diagram:

Knowledge-Submission-v2

@nerdalert
Automate file uploading to a common knowledge documents repo
9467d83 
- Adds a drag-and-drop file upload (PDF, Markdown)
- Creates a signed PR with uploaded documents in the dedicated knowledge
docs repo and captures the commit SHA that is maintained with a
merge commit. The SHA and file names are then populated back into
the knowledge submission form.

Signed-off-by: Brent Salisbury <bsalisbu@redhat.com>
@nerdalert nerdalert marked this pull request as draft June 17, 2024 04:57
@nerdalert
Copy link
Member Author

nerdalert commented Jun 17, 2024 •
edited
Loading

WIP PoC demo video:

file-upload-demo-720p.mp4

The test repos in the demo:

@nerdalert
Change the workflow to fork an upstream doc repo
b8273dc 
Signed-off-by: Brent Salisbury <bsalisbu@redhat.com>
@nerdalert
Copy link
Member Author

nerdalert commented Jun 19, 2024 •
edited
Loading

  • adjust the knowledge doc fork files to be timestamped for uniqueness in the case the user re-uploads the docs so the commit diff will show the file.
  • docs dir forks a central repo template from instructlab. This maintains some consistency but avoids instructlab repos from storing knowledge docs in ilab repos.
  • resolve the scenario where a user uses ssh keys for commits
  • resolve the race condition that occurs on the first run where the upstream repos need to be forked. Added a delay before retrieving the base SHA.
  • schema version missing from the submission

@nerdalert nerdalert marked this pull request as ready for review June 20, 2024 00:13
vishnoianil
vishnoianil approved these changes Jun 20, 2024
View reviewed changes
Copy link
Member

@vishnoianil vishnoianil left a comment

Choose a reason for hiding this comment

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

LGTM

@vishnoianil vishnoianil merged commit d90b384 into instructlab:main Jun 20, 2024
@hemajv hemajv mentioned this pull request Jun 20, 2024
Open
@nerdalert nerdalert mentioned this pull request Jun 22, 2024
Closed
candyhy pushed a commit to candyhy/ui that referenced this pull request Sep 22, 2024
@artreimus
Merge pull request instructlab#6 from ongstacy65/hotfix/contribute-ya…
bd895e0 
…ml-import-knowledge

[Hotfix] Types in the contribute yaml import knowledge
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@vishnoianil vishnoianil vishnoianil approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@nerdalert @vishnoianil