Giter Club home page Giter Club logo

kip's People

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

kip's Issues

Router issues with HTTPS

An issue occurs when the router file is generated with https, Even if trusted_proxies is enabled, it wont generate https base route.

Print format

It would be nice to have a printable format, without the left menu
image

Design

Improve general design

  • Wireframes
  • Clean base code
  • Implementation

Using VuePress as renderer

It could be nice to use VuePress as renderer of the KB, as it already pack many Markdown extension and a lot of themes.

Keyboard shortcuts

We should be able to navigate using keyboard :

  • On a document E to switch to Edit
  • On a document P to switch to Presentation mode
  • On edition mode CTRL+s to save
  • On edition mode Escape to switch to Show

What do you think folks?

Rework dev onboarding

  • Readme is not clear in the samples commands : Using Yarn or NPM ?
  • Composer can maybe launch yarn or npm i? (Also it is not yarn install, just yarn and yarn dev-server
  • Having to launch 2 commands to run it is long and not fun
  • Should create the storage folder or change that folder to something easier / quicker to get started with, and that contains already a .md
  • Maybe a .sh ?
  • We got lots of warnings :

Capture d’écran 2020-05-18 à 08 01 32

Rework the navigation

It is difficult to navigate between different files and folders, so we need to rethink all the navigation workflow.

Having a home page management

Just like VuePress having a home page that could serve as :

  • Quick context explanation
  • Some illustrations
  • An index of mains documentations available

Quick sample : Capture d’écran 2020-05-18 à 07 53 28

LDAP

Restore LDAP authentication

Images to S3

after #18 we should also be able to send files using S3 like storages.

tooltip : for testing purpose, we can use minio

Add a favicon

KIP does not have a favicon yet, it should be added to contribute to a visual identity.

Creating a document from non-empty folder

As it is, one can only create a document from an empty folder.

  • enable to create new documents from non-empty folders too.
  • add a proposition to create a readme when we click on a folder which has no readme (right now it just says that the document "title of the folder" couldn't be found and propose to create a new document, without mentioning a readme

Add a search engine

It would be nice to have a search bar to quickly get to a specific file.

At first, the search engine could be like the VuePress one. It could later be via ElasticSearch.

Better UI for the editor

The editor isn't enough, an editor like HackMD would be better, especially for the previsualization tool.

Management of permissions

We need a management of permissions (to do after the issue #20 ) :

  • there is a need to think about the management of permissions, knowing that we will have the authentification through LDAP

I suggest some specifications :

  • for non authentified people :
    • possibility to read a file only, if it is available for the public
  • for registered people
  • make a file public
  • make a file private
  • write / edit a file

S3 Storage

We should be able to use S3 Storage for all the files even markdowns.

CSS / UI rework

This needs to be done after the issue #34 : it also needs conception so don't hesitate to suggest different things.

User Guide

Redact a User guide for installation, configuration and usage

Also add informations on how to use with docker.

Permissions

We need the following permissions :

  • Read the KB
    • Public or Authenticated
  • Write in the KB
    • Authenticated

Maybe add roles ? Keep in mind that we'll have to implement also #20

  • Specs of the permission
  • Implementation

https issues

Cannot run Kip with HTTPS, I have issues about the _/left page which is loaded using HTTP.

Mixed Content: The page at 'https://domain.co/#/' was loaded over HTTPS, but requested an insecure XMLHttpRequest endpoint 'http://domain.co/_/left'. This request has been blocked; the content must be served over HTTPS.

Rework the left minimap

The minimap is the navigation menu on the left. In order to make navigation easier and improve documents visibility :

  • enable an horizontally manual resizing
  • add a functionality to collapse and expand folders and subfolders. Per default, have all folders collapsed
  • enable to hide the minimap
  • fix the issue that appears when cliking on a document on the bottom of the minimap, it reloads the minimap from the top and after a few seconds it scrolls down to the bottom
  • remove the left padding :
left-column li {
    padding-left: 0;
    display: block;

double escape on edition escapes

When you have the modal asking you if you want to leave without saving the document, if you press escape a second time, it exit the editor.

It should only close the modal.

Create community guideline

We need to create community guideline (what are our conventions in code, naming, and in versioning etc...)

indexation in Elasticsearch

Add elasticsearch index to project
if enabled, you should be able to index all files and be able to search in them.

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.