Giter VIP home page Giter VIP logo

flotiq-docs's Introduction

Flotiq logo

Flotiq documentation

This is the Flotiq documentation. It's available online here.

We are improving our documentation along as Flotiq improves. We are trying our best to keep it as up to date and clear as it is possible. If you wish to help us with that task - PRs are welcome.

Prerequisites

Starting the project with docker:

  • Installed docker

Starting without docker:

  • Installed python
  • Installed git

Installation

With docker: docker-compose up -d It will also start docs server.

Without docker:

pip install -r requirements.txt

To start server use:

# Use SOURCE_EDITOR_URL variable to point to speciffic dashboard url. By default, SOURCE_EDITOR_URL=https://editor.flotiq.com is used.
bash .github/scripts/get-plugins-docs.sh # Pull dynamically generated plugin docs. 
mkdocs serve # Start devlopment server

After that, the documentation should be available on http://localhost:4000.

Troubleshooting

If during installation without docker you will encounter error with no git present, add 2 environment variables:

  • GIT_PYTHON_GIT_EXECUTABLE - with path to git e.g /usr/bin/git
  • GIT_PYTHON_REFRESH - with value quiet to suppress more git errors

Collaboration

If you wish to talk with us about this project, feel free to hop on Discord Chat .

If you found a bug, please report it in issues.

We also welcome any PR with documentation improvements (or typo fixes ;) ).

Aliasing

Some files are dynamically generated (e.g. all pages describing events and classes for plugin API). Those pages can be referred with an alias:

<!-- Refer to PluginInfo page -->
[[PluginInfo.md]] 

<!-- Refer to PluginInfo page with an alternative name -->
[[PluginInfo.md|Page about PluginInfo class]] 

<!-- Refer to header on PluginInfo page with an alternative name -->
[[PluginInfo.md#example-header|Example section on the page]]

You can also add an alias to any existing page by dyfining it in the meta section of the markdown file:

<!-- Start of the markdown file -->
alias: some-example-alias

# Example page
...

flotiq-docs's People

Contributors

andrzejwp avatar ciotkacierpienia avatar dominikilski avatar hello-flotiq avatar jaceksekula1337 avatar jerdam avatar karolnet avatar krzysztofbrylski avatar likayeltsova avatar likrot avatar maciejlabedzkicodewave avatar mniemcewicz avatar rgembalik avatar salvadordalia avatar trzcina avatar whlukasz avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

flotiq-docs's Issues

Search API filters description vague

Issue Summary

The description of filters param in the search API is not clear as to how the request should actually look. Additionally, the field is declared without brackets, as opposed to other fields which can take multiple values.

image

the documentation should be improved to clearly state how a developer can use the filters.

Missleading CTA button below contact form

On the contact page there is contact form, and small button "Send".
Below is huge CTA button.

It can be misleading.
When a user fills out a form, they may accidentally click a larger button and lose the entered data.

CTA button should be moved or "Send" button should be more visible

image

Typo in curl example in creating CTD section

Hi,

I found a typo in the code example on this page https://flotiq.com/docs/API/content-type/creating-ctd/

curl -X POST "https://api.flotiq.com/api/v1/internal/contenttype" -H 'accept: */*' -H 'X-AUTH-TOKEN: YOUR_API_KEY' -H 'Content-Type: application/json' --data-binary '{"name":"blogposts","label":"Blog Posts","schemaDefinition":{"type":"object","allOf":[{"$ref":"#/components/schemas/AbstractContentTypeSchemaDefinition"},{"type":"object","properties":{"title":{"type":"string"},"postContent":{"type":"string"}}}],"required":["title","postContent"],"additionalProperties":false},"metaDefinition":{"propertiesConfig":{"title":{"label":"Title",inputType":"text","unique":true},"postContent":{"label":"Post content","inputType":"richtext","unique":false}},"order":["title","postContent"]}}'

Missing " before the first occurrence of inputType property.

I think the error description returned from the API is quite misleading: Invalid json message received.

Issue Summary

Typo in code example.

More information about posibble problems with sdk

I suggest some additional informations which should help users to easier get SDK packages working for them:

  • Information about needed Java installed to run command
  • Information about possibly problem with plugin versions and how to solve it
  • Information that user should have create new file with configuration and requests. It's showed on the video below, but for me it wasn't obvious.
  • Information that user should copy example request to check if it work, he just should use request from sdk docs.
  • Information how to call the code from app.js (file with conf and request)

Filter description for listing content objects is wordy and hard to read

The description of filters for content object listing is chaotic and hard to read due to the sheer amount of filters and descriptions for each and every one of them. Also, examples are not clear enough, so it's harder to translate them into a project.

https://flotiq.com/docs/API/content-type/listing-co/#listing-content-through-the-api

The whole part of the page describing filters is wordy and takes up the majority of the page content.

Please consider creating a selecting list for every filter type as you do with response examples and overall make the page more user-friendly.

Installation without docker - command 'mkdocs' not found

During installation on wsl2, I follow instructions:

Without docker:
pip install -r requirements.txt
To start server use: mkdocs serve

Then I get

$ mkdocs serve
Command 'mkdocs' not found, but can be installed with:
sudo apt install mkdocs

After I type

$ sudo apt install mkdocs

it works as expected

Should it be added to the readme, or did I miss something?

Troublesome explenation for hydration in `Getting single Content Object`

The explanation of hydration in the Getting single Content Object section would be much easier to understand if, instead of showing a very long GET result with hydration level 2, you would present an example of a hydrated and non-hydrated object, as you did in Listing Content Objects section.

Add workflow documentation

Issue Summary

The documentation for workflows is missing, and since this feature is particularly interesting to our enterprise customers - we should provide a brief description.

A banner rotator issue - data is not hydrated when using scoped API key

Hi,

I've read the article about Banner rotator
It seems cool and very easy to use, but I have some problems with the example.

In your example in js code, you're using banners object's properties. The keys are lowercased, not such like in your example, so you should use f.eg. {rotator.width}x${rotator.height} instead of {rotator.Width}x${rotator.Height}.

I also have a problem with hydration, but only when using fetch in the browser. Curl and postman's responses are ok.

It doesn't work, so I cannot use additional properties like id or extension., but I've changed my scoped API key, which has all permissions to a global one and it started works.

Do you have any idea why is that?

(I'm working in local env).

Issue Summary

Hydration does not work with scoped API key.

Aggregation isn't working with numeric field

Hi, it's me. Again.

I'm trying to aggregate data according to the Search Api Deepdive article. I can't make it work with rate property which is a numeric type.

This is how schema looks like:

{
            "id": "",
            "name": "blogposts",
            "label": "Blog Posts",
            "internal": false,
            "schemaDefinition": {
                "type": "object",
                "allOf": [
                    {
                        "$ref": "#/components/schemas/AbstractContentTypeSchemaDefinition"
                    },
                    {
                        "type": "object",
                        "properties": {
                            "rate": {
                                "type": "number"
                            },
                            "title": {
                                "type": "string",
                                "minLength": 1
                            },
                            "postContent": {
                                "type": "string"
                            }
                        }
                    }
                ],
                "required": [
                    "title"
                ],
                "additionalProperties": false
            },
            "metaDefinition": {
                "order": [
                    "title",
                    "postContent",
                    "rate"
                ],
                "propertiesConfig": {
                    "rate": {
                        "label": "Rate",
                        "unique": false,
                        "helpText": "",
                        "inputType": "number"
                    },
                    "title": {
                        "label": "Title",
                        "unique": true,
                        "helpText": "",
                        "inputType": "text"
                    },
                    "postContent": {
                        "label": "Post content",
                        "unique": false,
                        "helpText": "",
                        "inputType": "richtext"
                    }
                }
            },
            "deletedAt": null,
            "createdAt": "2021-03-23T14:36:47.000000+0000",
            "updatedAt": "2021-03-25T10:33:53.000000+0000"
        }

Is it a bug or am I doing something wrong?

Issue Summary

Data cannot be aggregated if you are using numeric type property.

Search API - when to use keyword, order by issue

Search API is based on ElasticSearch, but ES knowledge should not be necessary to use standard search functions.

Search docs: https://flotiq.com/docs/API/search/

Example request with order_by, according to docs:

  1. Search all [works] https://api.flotiq.com/api/v1/search?q=*&auth_token=__TOKEN__
  2. Search all ordered by created [error]: https://api.flotiq.com/api/v1/search?q=*&order_by=created&auth_token=__TOKEN__

Search all ordered by causes error:

        "q": [
            "Malformed query"
        ]
    }

We should use created.keyword (notice "keyword", that is not mentioned in docs)
https://api.flotiq.com/api/v1/search?q=*&order_by=created.keyword&auth_token=__TOKEN__
And it works fine.

Please add info on when should I use .keyword or refer to ES docs

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.