kuzzleio / documentation Goto Github PK
View Code? Open in Web Editor NEWKuzzle Documentation
Home Page: https://docs.kuzzle.io
License: Apache License 2.0
Kuzzle Documentation
Home Page: https://docs.kuzzle.io
License: Apache License 2.0
Bring Kourou into Kuzzle Docs.
Hi,
The link "Replicate to Postgres" on https://docs.kuzzle.io/how-to/ is dead, https://docs.kuzzle.io/how-to/2/replicate-to-sql-with-generic-events shows a 404.
Thanks.
😑
In Go, public method names start with a capitalized letter. For instance, this documentation should be about AddListener
instead of addListener
: https://docs.kuzzle.io/sdk-reference/go/1/kuzzle/add-listener/
This remark should also be applied in the left navigation menu, obviously.
In the example request is a const, but should be a let.
It could works due to const behavior in JS, but semantically this is wrong.
https://docs.kuzzle.io/kuzzle-dsl/essential/geopoints
documentation not Found for GEO Point
Chevron are not rendered in markdown table, they are interpreted as html tag I think
| Property | Type | Description |
|--------------|---------|-------------|
| ``type`` | string | Types |
| ``collections`` | array<object> | List of collections |
Should render array<object>
The response format in https://docs-v2.kuzzle.io/sdk-reference/php/3/kuzzle/check-token/ talks about callback response with JS format, not PHP.
Add a banner if the current page is about a previous version of Kuzzle
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.
During the dev, the paths are different, so we do a lot of guesswork.
Rewrite the Kuzdoc framework:dev
command to recreate a prod-like file-tree before starting the dev server.
With the aim of using Algolia Doc-Search we need to index our documentation content with a Kuzzle version facet.
This will allow us to filter the search results and not show users results that do not match the selected Kuzzle version.
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
failed
or fail
?An `array<object containing:
and Rights (`allowed
credentials
params. Also login (strategy, credentials, expiresIn)
should be login (strategy, [credentials], [expiresIn])
because seems optional ?credentials
param type and also [ ] if optional ?create (index, collection, mapping = null, [options])
mapping should be [mapping = null]
string
not number
("2d", "3w")[ ]
and optional param is before required param, which is a semantic error.hits
containing array of docs and total
? (not written in resolve paragraph but only in example.result
key but create
and createOrReplace
return _source
Bad indentations on some code snippets :
https://docs.kuzzle.io/sdk/js/7/getting-started/react-native/
Only for Kuzzle v2 SDKs
Home page listing for example:
We have to see what other does (Algolia SDK, Youtube SDK, Sentry SDK, Stripe SDK, ...)
We should not build the documentation if the doc/
folder has not been modified in the current PR.
https://docs.netlify.com/configure-builds/file-based-configuration/#ignore-builds
git diff --exit-code master -- doc/ 2-dev -- doc/
Saving a file should livereload the served frontend with the new modifications.
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? }
npm run dev
On branch master
, with Node v10.12.0.
All anchors are brokens
https://docs.kuzzle.io/core/1/plugins/guides/strategies/auth-functions/
They remove the auth-functions
part or the url, they shouldn't
When you click on the SDK dart link in the SDKs list, you should get to the getting started flutter
Currently we are redirected to the Kuzzle constructor page
When following a link containing an anchor, I expect the documentation page to jump to that anchor.
E.g. https://docs.kuzzle.io/core/2/guides/main-concepts/data-storage/#arrays
The anchor is ignored.
Missing Protocol pages for Go SDK documentation
Pages should be visible for the pages under the Protocol section at https://docs.kuzzle.io/sdk-reference/go/1/protocols/
Empty page with links to report the error
Create documentation pages
Visit https://docs.kuzzle.io/sdk-reference/go/1/protocols/
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.
Deadlink https://docs.kuzzle.io/core/1/plugins/guides/strategies/overview/
One of the exposed authenticators name
to https://docs.kuzzle.io/core/1/plugins/guides/strategies/#registering-authentication-strategies-default
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!
Open Graph meta of each page should contain:
We should use that information to then generate an open graph image on the fly so when we get indexed by services google/twitter/linkedin, our links would be more appealing.
Launch at compile time (deploy on now.sh)
https://github.com/vercel/og-image
Generate the OG tags at build.
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.
this command https://github.com/kuzzleio/kuzdoc/blob/master/src/commands/framework/install.ts#L66 cannot work in travis because travis checkout systematically on another branch (e.g. https://www.travis-ci.com/github/kuzzleio/sdk-dart/jobs/379389222#L194) so it never clones the "master" of the documentation.
Working on the documentation framework (i.e. delivering new features from this repository) is often a pain for the following reasons.
.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./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)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"
😑
As an end user, I'd like to have a Getting Started with Sigfox
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.
I see the both title in the right menu
## JS Title
## Go title
As an end user, I'd like to have anchor on h3 links in the documentation
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.
Since we upgraded Vuepress to 1.5.0, Hot reload no longer works
Images to load correctly, given that the sources are present.
kuzzle/doc/2/guides/essentials/admin-console/index.md
Images/Assets are not correctly loaded.
https://docs.kuzzle.io/core/2/guides/essentials/admin-console/
On mobile, on a 404 page, when I click on the burger menu button, the sidebar with the main menu should be showed
nothing happens
page 404 has its own layout, the Sidebar and/or TopMenu component must be missing
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 byeithera searchUsersor a scrollUsersquery
Fix documentation.
When I try to obtained by scrollUsers
query, we have an error :
The request must specify a scrollId.
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
NodeJS 6.10.0
ElasticSearch 5.4
Kuzzle 1.4.3
https://docs-v2.kuzzle.io/sdk-reference/cpp/1/kuzzle/constructor/#getter-setter-default
https://docs-v2.kuzzle.io/sdk-reference/java/1/kuzzle/constructor/#getter-setter-default
The notes mention properties that are not mentioned in the table above them.
c6452010dc26eb671d637214f1110c91
kuzzle
Write down documentation guideline on how to use JS SDK with angular 2
There is no way to scroll into the left menu of all pages in documentation when screen view is larger than 1220px.
This can be tested on all pages with a lot of items in left navigation like:
https://docs.kuzzle.io/core/1/guides/getting-started/running-kuzzle/
https://docs.kuzzle.io/sdk/js/6/getting-started/node-js/
must have: please do not insert some fancy scroll bar, this is not accessible: they often override user navigator/mouse configuration
Since we are likely to have deprecated SDKs (as the Java atm) we want to sort them to have the deprecated sdks always at the end of the list.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.