Knowledge Repo

About the Knowledge Repo

The Knowledge Repo project aims to streamline the sharing of knowledge among data scientists and other technical roles by utilizing data formats and tools that are commonly used in these professions. Our platform offers various options for storing and managing "knowledge posts", with a focus on utilizing notebooks (such as R Markdown and Jupyter/IPython Notebook) to better promote reproducible research.

Content Submission Options

1. Github Integration:

Easily submit your posts in markdown format directly through Github. Our platform will automatically detect and publish your new content in a timely manner.

2. Built-in Editor:

Utilize our user-friendly editor to compose and upload your posts in various formats including Jupyter Notebook, R markdown, and Google document link. We securely store your content on our internal storage for easy access and management. Users can make updates, delete, share, and add comments to their posts after publishing.

Getting Started

• Installation Instruction

• Hosted Live Version

• Source

  For more information about the motivation and inspiration behind this project, we encourage you to read our Medium Post.

Contact

• Bug reports
• Ask us questions
• Knowlegde-repo Slack
• Email: [email protected]

Screenshots

| Name | Screenshot(s) | |---------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------| | Feed | | | Example Post | | | New Post | | | Post Form | | | Stats | |

Issues

[KP]add env for S3 and GCS credential

opened on 2023-02-24 03:37:02 by JJJ000

Description of changeset: add env for S3 and GCS credential

Test Plan: [x] CI

Reviewers: @csharplus @mengting1010

Knowledge Repo Roadmap?

opened on 2022-12-08 23:02:40 by rsenseman

I see there has been some recent activity of PRs being merged to Knowledge Repo. I periodically evaluate Knowledge Repo to see if it works for our deployment and user needs; Are there any plans, roadmap, or general info to share about future development?

Set up mail client for approvals

opened on 2022-07-27 13:35:19 by Amanotas20

Hi!

I would like to know how to set up the mail client to send posts approval requests and also block the publish option while the post is in review state. has anyone done this so far?

Thanks

Getting "non-zero exit status 128"

opened on 2022-05-28 22:26:23 by oneextrafact

Receiving the following error message any time I try to run a command using the knowledge_repo tool:

Exception encountered: Command '['git', 'rev-parse', 'HEAD']' returned non-zero exit status 128.

Generally whatever command I was trying to run will complete, so I'm not sure what it means. I'm using Python 3.8 on WSL2.

Unfortunately, there are no authentication mechanisms configured. Please contact your system administrator to enable authentication.

opened on 2022-04-21 08:55:29 by kkk845

what should i do?

How to develop/build locally?

opened on 2021-11-19 16:13:48 by sepans

Hi, Thanks for open sourcing this project. I am trying to setup knowledge repo for our org and I need to fix and modify few things.

Like this bug that I keep getting and seems to be fixed but not released. Maybe pip installing from git gets the fix but need to be able to modify the code as well.

So first question: Is this repo actively being maintained?

I am happy to expand the documentations from my learnings (and possibly adding new features) but first need to be able to setup the development environment locally to make sure I can maintain it at least for our org for the long term. Could you help me with that?

Thanks.

Releases

v0.9.3 2023-02-22 03:38:42

This is a major release with several small improvements and bugfixes.

Features and improvements:

1. Enable Cloud Storage Based Knowledge Repo for S3/GS
2. Online Jupyter Notebook Management Flow
3. Easy Setup Script, [link]

Bugfixes: 1. Google/Github Authentication Fix 2. Default Post Thumbnail is auto-generated based on content type

v0.9.2 2023-01-05 19:50:01

This release contains several functionality bug fixes including google authentication, direct s3 post upload.

v0.9.1 2022-04-08 00:07:51

This release contains several functionality bug fixes and code quality improvement.

v0.9.0 2021-01-20 02:55:37

This release contains a UI design update and multiple UI and functionality bug fixes.

v0.8.9 2020-05-22 17:43:52

This is a minor release that includes some bug fixes and documentation updates.

2018-12-17 21:58:45

This is a minor release that fixes some bug and documentation nits.

Bugfixes: - Fix sorting in the post index table layout (#475) [@srowen] - Fix rendering of months in stat plots (#474) [@srowen] - Fix Python 2 string handling, resulting in several bugs [@matthewwardrop]

Documentation improvements: - Add guidance to kp preview command about how to access preview when running remotely. [@matthewwardrop] - Add configuration guide for using SSH authentication GitHub-backed knowledge repositories (#477) [@srowen] - Improve rendering of options prefixed by two hyphens (e.g. --flags) (#476) [@srowen]