3 ms·

I want to use Github to collect information like this, except about kitten issues, causes, and solutions. My focus is creating the tools to improve the state of

I want to use Github to collect information like this, except about kitten issues, causes, and solutions. My focus is creating the tools to improve the state of kitten care and rescue, systematically and systemically. GitHub has many powerful features for an interactive project like mine. However, I've never used GitHub before. Help?

dormento 3y ago
Hi, (I don't know how familiar you are with the following topics). As long as your documentation is just plain text files, it can be versioned easily. In fact, many people have used github to create whole books about many different subjects. It ties nicely into the "issue tracker" functionality, cause you can use it as a starting point for discussions that later turn into new functionality or fixes. You can also use the builtin wiki functionality, just got to "Wiki" on a new repo and click "new page". This has the added benefit that you don't really need to understand the git tool itself and you can start creating content right away. Either way, I recomend looking up "markdown syntax", as it is very convenient when you're writing a book and its also used for the wiki functionality. Hope it helps!
- growingkittens 3y ago
  Thank you! My current idea is to upload the project as an obsidian vault to GitHub. That would contain markdown files that can be used as-is, and vault configuration files. Obsidian has a variety of plugins for manipulating files and their data. I am a non-technical technical person in that I understand a lot of random technical concepts, but not necessarily how they work in practice. I'm not too worried about creating content right away. I am more concerned with designing the system correctly and then working on converting my project to that system.
  - dormento 3y ago
    Then i think it comes down to who is the end user and how you plan to integrate into their current workflows. For example, are you after the good-samaritans or the smaller vet clinics? Are there any differences between how the two would use this information? What is more important? Ease of use or maintenance of knowledge? Etc
    - growingkittens 3y ago
      Thank you for these focusing questions. The first phase of the project is identifying, collecting, and documenting kitten issues and solutions. The goal is to create a central repository for academic purposes, because kitten information is fragmented among nonprofits and cat breeders. The repository is a first step in answering the question "What can I do to help kittens?" for any skill level). It's the technical information that the rest of the project is based on. I think maintenance is more important for this first phase. Being human- and machine-readable is important. Ease of use is more important in later stages.

dormento 3y ago

Hi, (I don't know how familiar you are with the following topics). As long as your documentation is just plain text files, it can be versioned easily. In fact, many people have used github to create whole books about many different subjects. It ties nicely into the "issue tracker" functionality, cause you can use it as a starting point for discussions that later turn into new functionality or fixes. You can also use the builtin wiki functionality, just got to "Wiki" on a new repo and click "new page". This has the added benefit that you don't really need to understand the git tool itself and you can start creating content right away. Either way, I recomend looking up "markdown syntax", as it is very convenient when you're writing a book and its also used for the wiki functionality. Hope it helps!

growingkittens 3y ago
Thank you! My current idea is to upload the project as an obsidian vault to GitHub. That would contain markdown files that can be used as-is, and vault configuration files. Obsidian has a variety of plugins for manipulating files and their data. I am a non-technical technical person in that I understand a lot of random technical concepts, but not necessarily how they work in practice. I'm not too worried about creating content right away. I am more concerned with designing the system correctly and then working on converting my project to that system.
- dormento 3y ago
  Then i think it comes down to who is the end user and how you plan to integrate into their current workflows. For example, are you after the good-samaritans or the smaller vet clinics? Are there any differences between how the two would use this information? What is more important? Ease of use or maintenance of knowledge? Etc
  - growingkittens 3y ago
    Thank you for these focusing questions. The first phase of the project is identifying, collecting, and documenting kitten issues and solutions. The goal is to create a central repository for academic purposes, because kitten information is fragmented among nonprofits and cat breeders. The repository is a first step in answering the question "What can I do to help kittens?" for any skill level). It's the technical information that the rest of the project is based on. I think maintenance is more important for this first phase. Being human- and machine-readable is important. Ease of use is more important in later stages.