Details

      Description

      Phase 1 input required:

      -Intended usage, user, audience (expected knowledge level)
      -Input on TOC topics to cover

      No reviews matched the request. Check your Options in the drop-down menu of this sections header.

        Activity

        Hide
        ingenthr Matt Ingenthron added a comment -

        Sergey, can you put together the requested info in the description?

        Show
        ingenthr Matt Ingenthron added a comment - Sergey, can you put together the requested info in the description?
        Hide
        kzeller kzeller added a comment -

        Hi Karen and Matt

        Today I've pushed nginx module 0.2.0

        Here are doc sources for it
        https://github.com/couchbaselabs/couchbase-nginx-module/tree/master/doc

        I've pushed it to labs page already
        http://labs.couchbase.com/couchbase-nginx-module/

        Any feedback is welcome

        ------------------

        README review. Request for more information:

        Hi Sergey,

        So I read through this README/raw info. and here are some areas that people will need more help/info to understand how to use this. Below are some areas where users will need more information.

        Don't worry about how you write this information, just answer the questions as best you can at this point in your README.

        I have an open documentation ticket on nginx and will add these questions that need more information (http://www.couchbase.com/issues/browse/MB-7987)

        1) Description:

        -Why would a developer want to use this versus other solutions?
        -When does a developer want to use it?
        -What are the use cases for this module? What problems is a developer trying to solve and this is more suitable than other solutions?
        -What are the scenarios for this module? In what situations would a developer want to use this? What scenarios are out of scope (if they want to accomplish something with their application on Couchbase, they need to use some other solutions)?
        -What do we assume a user/developer already knows in order to use this module? What should they already be familiar with in order to use this?

        -Here is some text:

        "By default, the module can use information, accessible in the request, to construct data packet. As a key it use part of the request URI, which remains after stripping the name of the matching location.
        location /cache/ {
        couchbase_pass;
        }
        In example above, if address /cache/example.html will be requested from the server, then the key will be example.html."

        -What does this mean? Is this the request format you can make with this module?

        "To choose command, which will be sent to Couchbase Server, it use HTTP method. The table below shows correspondence commands to the methods."

        -How do you build a request with the information in this table?

        2) Configuration Directives

        -I think this is how to connect to a bucket….Yes?

        -How does this translate into HTTP request?

        -What does severity mean? Does it apply to all items you show in the syntax? Does it apply to the items in default?

        -What do the "context" mean? Are those options? Are those possible parameters? Which do each of the three mean? What different behavior do you get if you use the three different ones.

        -For syntax:couchbase_connect_timeout time;, How does that look as an actual request in a request block?

        • For syntax:couchbase_timeout time; How does that look as an actual request in a request block?

        3) Variables

        -I think someone uses variables to perform all their CRUD operations?…. Are these technically provided as HTTP request variables? Please explain….

        -How to each of these variables translate into HTTP requests?

        -Are there any HTTP payload responses that will happen on success? Any payload on failure? If so, what are they?

        -Please provide information/listing/options and examples for other CRUD operations that someone can use with nginx, if they exist?

        4) System Requirements

        -What does someone need set up on their development environment to use this? OS, any IDE, any platforms that are specifically supported and not supported? Do we support this module in production yet? If so, what environment requirements?

        5) Usage

        • Once you have nginx installed with these instructions, how can someone accomplish a a) connect, b) set and c) get?

        Hope that helps with how we think about how this will be used.

        Regards,

        Karen

        Show
        kzeller kzeller added a comment - Hi Karen and Matt Today I've pushed nginx module 0.2.0 Here are doc sources for it https://github.com/couchbaselabs/couchbase-nginx-module/tree/master/doc I've pushed it to labs page already http://labs.couchbase.com/couchbase-nginx-module/ Any feedback is welcome ------------------ README review. Request for more information: Hi Sergey, So I read through this README/raw info. and here are some areas that people will need more help/info to understand how to use this. Below are some areas where users will need more information. Don't worry about how you write this information, just answer the questions as best you can at this point in your README. I have an open documentation ticket on nginx and will add these questions that need more information ( http://www.couchbase.com/issues/browse/MB-7987 ) 1) Description: -Why would a developer want to use this versus other solutions? -When does a developer want to use it? -What are the use cases for this module? What problems is a developer trying to solve and this is more suitable than other solutions? -What are the scenarios for this module? In what situations would a developer want to use this? What scenarios are out of scope (if they want to accomplish something with their application on Couchbase, they need to use some other solutions)? -What do we assume a user/developer already knows in order to use this module? What should they already be familiar with in order to use this? -Here is some text: "By default, the module can use information, accessible in the request, to construct data packet. As a key it use part of the request URI, which remains after stripping the name of the matching location. location /cache/ { couchbase_pass; } In example above, if address /cache/example.html will be requested from the server, then the key will be example.html." -What does this mean? Is this the request format you can make with this module? "To choose command, which will be sent to Couchbase Server, it use HTTP method. The table below shows correspondence commands to the methods." -How do you build a request with the information in this table? 2) Configuration Directives -I think this is how to connect to a bucket….Yes? -How does this translate into HTTP request? -What does severity mean? Does it apply to all items you show in the syntax? Does it apply to the items in default? -What do the "context" mean? Are those options? Are those possible parameters? Which do each of the three mean? What different behavior do you get if you use the three different ones. -For syntax:couchbase_connect_timeout time;, How does that look as an actual request in a request block? For syntax:couchbase_timeout time; How does that look as an actual request in a request block? 3) Variables -I think someone uses variables to perform all their CRUD operations?…. Are these technically provided as HTTP request variables? Please explain…. -How to each of these variables translate into HTTP requests? -Are there any HTTP payload responses that will happen on success? Any payload on failure? If so, what are they? -Please provide information/listing/options and examples for other CRUD operations that someone can use with nginx, if they exist? 4) System Requirements -What does someone need set up on their development environment to use this? OS, any IDE, any platforms that are specifically supported and not supported? Do we support this module in production yet? If so, what environment requirements? 5) Usage Once you have nginx installed with these instructions, how can someone accomplish a a) connect, b) set and c) get? Hope that helps with how we think about how this will be used. Regards, Karen
        Hide
        kzeller kzeller added a comment -

        Superceded by:

        NGXCBM-4

        Show
        kzeller kzeller added a comment - Superceded by: NGXCBM-4
        Hide
        kzeller kzeller added a comment -

        Superceded by:

        NGXCBM-4

        Show
        kzeller kzeller added a comment - Superceded by: NGXCBM-4

          People

          • Assignee:
            avsej Sergey Avseyev
            Reporter:
            kzeller kzeller
          • Votes:
            0 Vote for this issue
            Watchers:
            5 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Gerrit Reviews

              There are no open Gerrit changes