Uploaded image for project: 'Couchbase Documentation'
  1. Couchbase Documentation
  2. DOC-3982

5.5 Travel Sample Python Update

    XMLWordPrintable

Details

    • DOC-2020-S24-Dec13
    • 1

    Description

      Suggesting that the steps to run try-cb-python with Couchbase Server 5.0/5.5 should be on the master branch of the repository (currently on branch `5.0`). We could create a 4.6 branch for instructions that relate to running with Couchbase Server 4.6.

      At the same time, we should also:

      [ ] check that the app runs with Couchbase Server 5.5
      [ ] update the tutorial content and screenshots to reference Couchbase Server 5.5

      Using this ticket as reference before doing the same for other SDKs.

      Attachments

        Issue Links

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

          Activity

            Just a quick note here… there was a discussion for Spock on the Travel Sample. The determination was that the sample app was missing it's goals (but the dataset is probably still good) and needed to be re-thought. It's probably not a lot of work, but in the end PM didn't prioritize it in the UX and DA was less engaged so no one picked it up.

            I think Chin Hong or a delegate should be involved here. We should at least consider an app update, and if so that should be driven based on what we want that initial developer experience to be like. RBAC and changing dependencies on the sample projects mean just porting over the earlier content won't be very good.

            ingenthr Matt Ingenthron added a comment - Just a quick note here… there was a discussion for Spock on the Travel Sample. The determination was that the sample app was missing it's goals (but the dataset is probably still good) and needed to be re-thought. It's probably not a lot of work, but in the end PM didn't prioritize it in the UX and DA was less engaged so no one picked it up. I think Chin Hong or a delegate should be involved here. We should at least consider an app update, and if so that should be driven based on what we want that initial developer experience to be like. RBAC and changing dependencies on the sample projects mean just porting over the earlier content won't be very good.

            Matt Ingenthron thanks for the background info. The goal here is only for minor content changes to make sure the initial developer experience is smooth. A wider app update would indeed need to be driven at a higher level. But regardless of the app, there will be maintenance. This is just a doc ticket for the doc team to dabble into sample app maintenance (and use the cool AsciiDoc features with that). Once it is updated for a single SDK language, it gets easier to spread the work to update others (at least it's my experience doing it on mobile).

            jamiltz James Nocentini added a comment - Matt Ingenthron thanks for the background info. The goal here is only for minor content changes to make sure the initial developer experience is smooth. A wider app update would indeed need to be driven at a higher level. But regardless of the app, there will be maintenance. This is just a doc ticket for the doc team to dabble into sample app maintenance (and use the cool AsciiDoc features with that). Once it is updated for a single SDK language, it gets easier to spread the work to update others (at least it's my experience doing it on mobile).

            Closing this ticket because the scope was not well defined.

            jamiltz James Nocentini added a comment - Closing this ticket because the scope was not well defined.

            Chin Hong: Can you or a delegate give some guidance on this at some point? We're in a less than ideal state in that the sample dataset is there, other samples depend on it, but the app/docs have mostly not been done because of lack of direction. Should it be revamped? Replaced? Should we mark the old apps as EOL?

            ingenthr Matt Ingenthron added a comment - Chin Hong : Can you or a delegate give some guidance on this at some point? We're in a less than ideal state in that the sample dataset is there, other samples depend on it, but the app/docs have mostly not been done because of lack of direction. Should it be revamped? Replaced? Should we mark the old apps as EOL?
            chinhong Chin Hong added a comment -

            We need to balance the need to have examples of all our features and over complicating our sample app.

            My suggestion is to keep the sample app simple to focus on the key concepts (basic CRUD and query) so that it serves its purpose as a Getting Started or Hello World app for new developers learning Couchbase.

            Other areas (like RBAC, eventing, analytics, search etc) can leverage the same sample data to create separate examples in their respective area. 

            Amarantha Kulkarni, can you take a lead on what we need to do in documentation for examples based on this high level guideline and review with the stakeholders? 

             

            chinhong Chin Hong added a comment - We need to balance the need to have examples of all our features and over complicating our sample app. My suggestion is to keep the sample app simple to focus on the key concepts (basic CRUD and query) so that it serves its purpose as a Getting Started or Hello World app for new developers learning Couchbase. Other areas (like RBAC, eventing, analytics, search etc) can leverage the same sample data to create separate examples in their respective area.  Amarantha Kulkarni , can you take a lead on what we need to do in documentation for examples based on this high level guideline and review with the stakeholders?   

            Closing - this is replaced by ongoing work for 3.0 in DOC-7838 

            richard.smedley Richard Smedley added a comment - Closing - this is replaced by ongoing work for 3.0 in DOC-7838  

            People

              richard.smedley Richard Smedley
              jamiltz James Nocentini
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Gerrit Reviews

                  There are no open Gerrit changes

                  PagerDuty