Coder Social home page Coder Social logo

Document APIcast parameters about apicast HOT 4 CLOSED

3scale avatar 3scale commented on May 29, 2024
Document APIcast parameters

from apicast.

Comments (4)

mikz avatar mikz commented on May 29, 2024

We try to document them in https://github.com/3scale/apicast/blob/v2/.env

from apicast.

andrewdavidmackenzie avatar andrewdavidmackenzie commented on May 29, 2024

Agree good to document somewhat in one 'doc' that is not code, but having in too many places causes an update overhead.

Thinking about your (valid) example of someone installing from OpenShift template and not seeing the code.... made me wonder what documents or mechanisms for showing information are available.... I think Joaquim mentioned to me the ability to embedd some "notices" in the template itself and they are shown to the user .... for that use case that might be a better place?

from apicast.

mikz avatar mikz commented on May 29, 2024

Someone installing from OpenShift template will see all of them as template parameters in the UI. Each param has description.

from apicast.

mayorova avatar mayorova commented on May 29, 2024

Closed by #192

from apicast.

Related Issues (20)

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.