apigee / apigee/devrel

Sackmesser report - inconsistent directory names

Open
#644 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement nice-to-have
Dominant language
Python
Stars
221
Forks
174
PR merge metrics
No merged PRs in 30d

Description

We have a minor inconsistency with the directory names created for sackmesser report
Each resource in /tools/apigee-sackmesser/cmd/report/helpers will have its own directory created

e.g.
mkdir -p "$export_folder/$organization/config/resources/edge/env/$environment/company"

This issue raises the question of whether the directory names should be singular or plural; /company vs /companies

/api-products
/caches
/developerapps (hyphen?)
/developers
/flowhook
/keystore
/kvm
/reference
/target-servers
/user
/virtualhost

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the resource helpers under /tools/apigee-sackmesser/cmd/report/helpers and the directory paths used by the sackmesser report command. Establish a consistent singular or plural naming convention for the listed resources, then update the affected directory names and verify that report output uses the agreed convention.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.