jab2870/knowledge-base

Fork 0

Add the ability to add existing files #16

New issue

Closed

opened 2020-12-23 12:55:50 +00:00 by jab2870 · 0 comments

jab2870 commented

2020-12-23 12:55:50 +00:00

Owner

This should copy an existing file into the knowledge base repo. The
functionality of this will vary depending on the type of file.

For the sake of simplicity, I will get it working for the following situations:

Markdown

If it is a markdown file it should be copied to the kb directory.

With Yaml title

If it has a yaml title, the file name should be changed to match it and a
warning displayed to the user so they know

Without a yaml title

The Name of the file should be converted to a title and used.

Both situations

In both situations, if a file already exists with the name of the "new" file, an
error is thrown and the user is asked to fix manually

Non-markdown

As time progresses, other plain text formats will probably be supported and will
be treated in a similar way to markdown

For binary files, there are 2 situations that I think are helpful:

An asset which is useful in another document

An example of this is an image that should be included in a markdown document.

These will be identified with the --asset flag. These will be stored within an
assets sub directory and will be indexed with the type of asset in the
database.

A binary document in itself

An example of this is a PDF that has been downloaded and should be treated as a
document in it's own right. These will be indexed as "normal" documents.

Both

In the case of binary documents, tags will be assigned by creating a yaml file
with the same name but with a yml extension. This will contain the same
information as the yaml header inside a markdown file.

For example, a document called test_document.pdf would have a yaml file
created with the name test_document.pdf.yml.

In the future, it would be helpful to have this auto-populate with information
although that is probably another issue.

This should copy an existing file into the knowledge base repo. The functionality of this will vary depending on the type of file. For the sake of simplicity, I will get it working for the following situations: # Markdown If it is a markdown file it should be copied to the kb directory. ## With Yaml title If it has a yaml title, the file name should be changed to match it and a warning displayed to the user so they know ## Without a yaml title The Name of the file should be converted to a title and used. ## Both situations In both situations, if a file already exists with the name of the "new" file, an error is thrown and the user is asked to fix manually # Non-markdown As time progresses, other plain text formats will probably be supported and will be treated in a similar way to markdown For binary files, there are 2 situations that I think are helpful: ## An asset which is useful in another document An example of this is an image that should be included in a markdown document. These will be identified with the `--asset` flag. These will be stored within an assets sub directory and will be indexed with the `type` of asset in the database. ## A binary document in itself An example of this is a PDF that has been downloaded and should be treated as a document in it's own right. These will be indexed as "normal" documents. ## Both In the case of binary documents, tags will be assigned by creating a yaml file with the same name but with a yml extension. This will contain the same information as the yaml header inside a markdown file. For example, a document called `test_document.pdf` would have a yaml file created with the name `test_document.pdf.yml`. In the future, it would be helpful to have this auto-populate with information although that is probably another issue.

jab2870 referenced this issue from a commit

2020-12-30 17:42:43 +00:00

Adds the ability to add files that already exist

jab2870 closed this issue

2020-12-30 17:43:41 +00:00

No labels

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: jab2870/knowledge-base#16

No description provided.

Rows
Columns