Code Monkey home page Code Monkey logo

Comments (6)

tianjing-li avatar tianjing-li commented on June 9, 2024

@llermaly yes please! Documentation changes would be greatly appreciated

from quick-start-connectors.

tianjing-li avatar tianjing-li commented on June 9, 2024

Actually noticed this is basically repo-wide across all connectors. I will handle updating the documentation instead for all the READMEs and specify that the Bearer token is needed for requests to /search. ty

from quick-start-connectors.

llermaly avatar llermaly commented on June 9, 2024

Sounds good. Having screenshots + some standard way of showing the env vars (like a table at the beginning) would be golden.

Besides that the process is very easy. I could configure and deploy 5 connectors in a couple of hours.

from quick-start-connectors.

tianjing-li avatar tianjing-li commented on June 9, 2024

@llermaly glad to hear it's been smooth for you so far. I just opened #136 to update all the curl requests with the required headers, the table idea is good, I'll make a note of it somewhere.

from quick-start-connectors.

llermaly avatar llermaly commented on June 9, 2024

Great! , for security reasons all the connectors should be enforced to use the API_KEY .

Two things I have seen on my journey:

  • It is not clear you have to invent an API Key, it took me a while to understand that at the beginning, I was looking for some key on the connector source
  • Some connectors (e.g Confluence) allows to not use API_KEY, but then to use it you have to send anything on the API_KEY for it to work

from quick-start-connectors.

tianjing-li avatar tianjing-li commented on June 9, 2024

Agreed, I can see that there can be ambiguity from the docs about what the CONNECTOR_API_KEY's purpose is. I've opened #143 to track this

from quick-start-connectors.

Related Issues (11)

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.