Giter Site home page Giter Site logo

kuzzleio / documentation Goto Github PK

View Code? Open in Web Editor NEW
8.0 10.0 5.0 19.1 MB

Kuzzle Documentation

Home Page: https://docs.kuzzle.io

License: Apache License 2.0

JavaScript 12.45% Go 0.05% C++ 0.06% Java 0.06% Ruby 2.42% Vue 19.16% Dockerfile 0.07% SCSS 65.73%
kuzzle documentation code-examples kuzzle-sdk test-the-tests hacktoberfest

documentation's People

Contributors

alexandrebouthinon avatar aschen avatar benoitvidis avatar berthieresteban avatar clementbolin avatar etrousset avatar fmauneko avatar imgbot[bot] avatar imgbotapp avatar jenow avatar kuruyia avatar kuzzle avatar leodau avatar njuelle avatar oliviercavadenti avatar rolljee avatar scottinet avatar sixla avatar thomas-mauran avatar thomasarbona avatar xbill82 avatar yoann-abbes avatar

Stargazers

avatar avatar avatar avatar avatar avatar avatar avatar

Watchers

avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar

Forkers

stafyniaksacha screamz a50397 socialskycorporation leftxs

documentation's Issues

Smøl UI details to fix

Links in warning blocks are rose on rose.
image

Inline code is bigger than line-height: sometimes it overlaps.
image (1)

Tables don't fill the width of the card container.
image (2)

Code blocks have unequal vertical padding.
image (3)

[plugins/1/essentials/strategies/index.md]

  1. Internal links don't work in the page
  2. The page lacks of code snippets
  3. Lacks of some explanation on when each hook is called (e.g. validate is verified before creating or updating the credentials)

Livereload is broken

Expected Behavior

Saving a file should livereload the served frontend with the new modifications.

Current Behavior

Webpack raises the following error

[metalsmith-watch] ✗ WebpackOptionsValidationError: Invalid configuration object. Webpack has been initialised using a configuration object that does not match the API schema.
 - configuration.module.rules[2].use should be one of these:
   non-empty string | function | object { loader?, options?, query? } | function | [non-empty string | function | object { loader?, options?, query? }]
   Details:
    * configuration.module.rules[2].use should be a string.
    * configuration.module.rules[2].use should be an instance of function.
    * configuration.module.rules[2].use should be an object.
    * configuration.module.rules[2].use should be one of these:
      non-empty string | function | object { loader?, options?, query? }
    * configuration.module.rules[2].use should be an instance of function.
    * configuration.module.rules[2].use[2] should be a string.
    * configuration.module.rules[2].use[2] should be an instance of function.
    * configuration.module.rules[2].use[2] has an unknown property 'ident'. These properties are valid:
      object { loader?, options?, query? }
    * configuration.module.rules[2].use[2] should be one of these:
      non-empty string | function | object { loader?, options?, query? }
 - configuration.module.rules[3].use should be one of these:
   non-empty string | function | object { loader?, options?, query? } | function | [non-empty string | function | object { loader?, options?, query? }]
   Details:
    * configuration.module.rules[3].use should be a string.
    * configuration.module.rules[3].use should be an instance of function.
    * configuration.module.rules[3].use should be an object.
    * configuration.module.rules[3].use should be one of these:
      non-empty string | function | object { loader?, options?, query? }
    * configuration.module.rules[3].use should be an instance of function.
    * configuration.module.rules[3].use[0] should be a string.
    * configuration.module.rules[3].use[0] should be an instance of function.
    * configuration.module.rules[3].use[0] has an unknown property 'ident'. These properties are valid:
      object { loader?, options?, query? }
    * configuration.module.rules[3].use[0] should be one of these:
      non-empty string | function | object { loader?, options?, query? }
 - configuration.module.rules[5].use should be one of these:
   non-empty string | function | object { loader?, options?, query? } | function | [non-empty string | function | object { loader?, options?, query? }]
   Details:
    * configuration.module.rules[5].use should be a string.
    * configuration.module.rules[5].use should be an instance of function.
    * configuration.module.rules[5].use should be an object.
    * configuration.module.rules[5].use should be one of these:
      non-empty string | function | object { loader?, options?, query? }
    * configuration.module.rules[5].use should be an instance of function.
    * configuration.module.rules[5].use[2] should be a string.
    * configuration.module.rules[5].use[2] should be an instance of function.
    * configuration.module.rules[5].use[2] has an unknown property 'ident'. These properties are valid:
      object { loader?, options?, query? }
    * configuration.module.rules[5].use[2] should be one of these:
      non-empty string | function | object { loader?, options?, query? }

Steps to Reproduce

  1. npm run dev
  2. edit and save a file
  3. you get the error

Context (Environment)

On branch master, with Node v10.12.0.

Dev workflow pains

Working on the documentation framework (i.e. delivering new features from this repository) is often a pain for the following reasons.

  • We have no pre-production environment (next-docs is more like a remote development staging).
  • It is very long and laborious to reproduce locally how a final production build will look (i.e. with some/all subrepos).
  • It is currently impossible to have a local development server with hot reload to work simultaneously on the framework (this repository) and the content (any sub-repository)
  • The doc framework is composed of a set of YML and JSON files that describe the structure and the subrepos (.repos/repositories.yml, .travis.yml, sdk.json, howto.json, header.json, non ehaustive) . It is very difficult to keep everything in sync with the individual subrepos.
  • The subrepos have their doc in /doc/${VERSION}, which is redundant and sometimes off-sync with the branch (which is always referencing a version). Plus, the meaning of ${VERSION} is unclear: sometimes it refers to the Kuzzle version, otherwise it's the version of the code of the repository (i.e. SDK version)

Can not use variable type with chevrons in markdown tables

Chevron are not rendered in markdown table, they are interpreted as html tag I think

Expected Behavior

| Property   | Type    | Description  |
|--------------|---------|-------------|
| ``type`` | string | Types    |
| ``collections`` | array<object> | List of collections  |

Should render array<object>

Actual behavior

image

Various feedback on SDK JS V2 documentation

Hello,

I list some errors on documentation v2, could you please reply in this thread when you fixed with the value fixed for each ticket. I need it for kuzzleio/sdk-javascript#319.

I want also tell that returns type are not consistent, sometimes we have some fields, sometimes not. This is also highly coupled with Elastic Search, which will need a lot of refactor once you'll release another database driver.

You can use checkmark for each ticket progression.

Regards

Issues

[SDK Go] Discrepancies in the AddListener events documentation

Description

The event description on the AddListener documentation is not the same than the description given by the Event Handling documentation

Also, AddListener seems to expect a json.RawMessage payload, while the described events in the Event Handling section give different payload types depending on the triggered event

Lastly, it would be nice if the documentation about functions dealing with events and the Event Handling section itself would both inform that, to use events, the following package must be imported: "github.com/kuzzleio/sdk-go/event"

Duplicate right menu entries with title in multiples sections

Expected Behavior

When I have a JS and a GO section with two different title inside, I want to see only the JS title in the right menu when I select JS and only the GO title in the right menu when I select GO.

Current Behavior

I see the both title in the right menu

Possible Solution

Steps to Reproduce

  1. Create a JS section with a ## JS Title
  2. Create a Go section with a ## Go title
  3. Render the section in a page

Context (Environment)

Screenshots (if appropriate)

image
image

Missing API entry documentation: Go SDK Protocols pages

Missing Protocol pages for Go SDK documentation

Expected Behavior

Pages should be visible for the pages under the Protocol section at https://docs.kuzzle.io/sdk-reference/go/1/protocols/

Current Behavior

Empty page with links to report the error

Possible Solution

Create documentation pages

Steps to Reproduce

Visit https://docs.kuzzle.io/sdk-reference/go/1/protocols/

Context (Environment)

Attempting to use Go SDK and connect to a Kuzzle endpoint from a Go 1.11.5 app over HTTP as opposed to a WebSocket.

[api/1/controller-security/scroll-users/index.md] Error in documentation

The below sentence in Arguments section of https://docs.kuzzle.io/api/1/controller-security/scroll-users/ seems bad. The cursor identifier cannot be obtained by scrollUsers query (only by searchUsers query)

scrollId: cursor unique identifier, obtained by either a searchUsers or a scrollUsers query

Expected Behavior

Fix documentation.

Current Behavior

When I try to obtained by scrollUsers query, we have an error :

The request must specify a scrollId.

Steps to Reproduce

This code throws an exception (see above)

kuzzle.queryPromise({controller: 'security', action: 'scrollUsers'}, {
    size: 5,
    scroll: '1m'
})

It's the same exception if we add a empty scrollId ("", null, undefined, false)

N.B.: if we try to add a non empty scrollId to the above code, we have the below error:

Non-existing or expired scroll identifier

Context (Environment)

NodeJS 6.10.0
ElasticSearch 5.4
Kuzzle 1.4.3

[content-request] Security is not documented in SDK 6

Hi,

I'm wondering how to create a user from SDK V6 JS. (In fact, I know how to do it but there is no documentation about security controller for the new SDK).
I don't understand why the securityController of SDK V5 JS or android is documented but not SDK V6.

Enhance the dev workflow on the framework repo

Expected Behavior

When working on the framework repo (i.e. this one), we should have the same file-tree as it's shipped on the prod/preprod, so that we don't mess things up with base/relative paths.

Current Behavior

During the dev, the paths are different, so we do a lot of guesswork.

Possible Solution

Rewrite the Kuzdoc framework:dev command to recreate a prod-like file-tree before starting the dev server.

As an end user, I'd like to have core classes Properties and Method in sub-menu

Introduce a third level of drop down menu in the documentation.

This is in purpose of documenting SDK core classes Properties and Methods in two distinct sub-menu.

Bonus: the current page named "Introduction" should be named with the name of the class.

The scope of this ticket is at least the JS SDK 7. We will update Kuzzle v2 SDK's incrementaly after that.

See microsoft documentation: https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task?view=netframework-4.8
!image-2019-11-28-05-12-05-305.png!

https://trello.com/c/w8Azqujk/182-adm-sdkusetokentoken

[content-request] Debug Kuzzle with VSCode tutorial

What were you trying to do?
Helping people on Discord.

Where would you expect to find the documentation you were looking for?
A page explaining how to debug Kuzzle (in a Docker container) with VSCode so that they can understand by themselves what's going on.

Did you find a workaround?
No.

[bug][Mobile] no sidebar menu on 404 pages

Expected Behavior

On mobile, on a 404 page, when I click on the burger menu button, the sidebar with the main menu should be showed

Current Behavior

nothing happens

Possible Solution

page 404 has its own layout, the Sidebar and/or TopMenu component must be missing

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.