Skip to content

Deployment steps in README are in illogical order #53

@spider-man-tm

Description

@spider-man-tm

First of all, thank you for creating this excellent Looker extension! We're excited to use it in our analytics workflow.

Issue Description

The current deployment steps in the README have an illogical order that could
confuse users during setup. This is a simple documentation fix that requires
only reordering the existing steps without any code changes.

Current Order (Steps 1-4)

  1. Create Artifact Registry repository
  2. Authenticate with gcloud
  3. Navigate to directory (cd dashboard-summarization/restful-service/src)
  4. Build and submit Docker image

Proposed Logical Order

  1. Navigate to directory (cd dashboard-summarization/restful-service/src)
  2. Create Artifact Registry repository
  3. Authenticate with gcloud
  4. Build and submit Docker image

Reasoning

  • Step 1 (Directory navigation) should be first because the Docker build
    command requires cloudbuild.yaml and Dockerfile to be present in the current
    directory
  • Without being in the correct directory, the build command will fail
  • The current order puts directory navigation as step 3, which is after creating
    resources that the build depends on

Impact

  • Users following the current order might experience confusion
  • Makes the setup process less intuitive
  • No functional impact, but improves user experience

Scope

This is a minor documentation improvement that:

  • ✅ Requires no code changes
  • ✅ Only involves reordering existing instructions
  • ✅ Maintains all existing content
  • ✅ Improves user experience

Would you like me to submit a PR to fix this ordering issue?

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions