Giter VIP home page Giter VIP logo

Comments (3)

benibilme avatar benibilme commented on June 9, 2024 1

Hello,

Thank you for the feedback. I have completely missed the update command, I guess I must have read without reading glasses. I am really angry with myself. Thank you for pointing it out. That's my bad.

On the other hand, I believe edit subcommand help is just copy paste from update command which misled me. The description of the options are the same as update. Category to update, author to update etc. Edit does not update them. I presume, they are used for selecting the artifact, based on your explanation. I believe the edit --help command output should be updated.

Being able to change the artifacts directory is a need in general. There may special directories which sinks with the cloud systems such as drop box. XDG directory structure is suggestion or convention. I presume, kb artifact directory will grow in size enormously. I would not want that directory be growing in my .local directory. I believe, it would be nice to give the user provide an alternative path. Yes, providing configuration file opens up new complexities, I believe in the long run, the software will be more usable.

Since your aim is creating a knowledge base management system, describing or commenting artifacts is essential. Adding a text file is different from a description. Categories, tags are different than descriptions or comments. They are needed for queries. Comment or description somewhat different. Title yes can be used to some degree, but with the title, I really would like to see the raw artifact name. I believe providing an optional comment or description capability will enhance title. In that case, kb list may display an additional column.

Thank you for the nice work and feedback.

from kb.

gnebbia avatar gnebbia commented on June 9, 2024

Hej!

Thanks for using kb, let's see if I can help you with your doubts.

  1. The edit command is just used to edit the content so it is not used in that way.
    To update the meta-information of an artifact you should use "update", for example:
kb update --id 3 --title "newtitle" --category "newcategory"

This will update the current artifact with id 3 to title "newtitle" and category "newcategory".

  1. That directory is the recommended default according to GNU standards, unfortunately now it cannot be changed unless you modify the code.

  2. You can add tags to each artifact, I wouldn't use sentences for that but it's up to you. Probably if you really need to use sentences you could just specify them inside the artifacts and then grep them with "kb grep".

For what concerns the documentation... each option is documented with the -h flag.
So for example if you type kb you will be presented with the list of commands with a short explanation.
Now if you need help/documentation on the update command, you can just do:

kb update -h

The same applies for each kb command.

Does that clear things up?

Thanks for the feedback,
we will try to implement a configurable directory for 0.1.8 + add docs on update.

from kb.

estribiyo avatar estribiyo commented on June 9, 2024

Possible workaround to change location...

  1. Move ~/.local/share/kb to desired location, for example ~/user/NextCloud
  2. Link new location to the old one: ln -s ~/user/NextCloud ~/.local/share/kb

And it's done... all data will be stored in cloud folder (change it to whatever you folder is instead of ~/user/NextCloud)

from kb.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.