mozilla-services / mozilla-services/autograph

Configurations need someway to be explorable

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

Nobody has claimed this yet.

code quality enhancement
Dominant language
Go
Stars
176
Forks
34
Avg merge
1d 17h
Merged PRs (30d)
3

Description

Configurations are hard to interpret for a human for several reasons:

  • There can be many <=> many relationships.
  • Many of the values are sensitive (and encrypted).
  • Different audiences use different namespaces when referring to keys, which often leads to ambiguity in requests and resultant rework.

Sanity of maintainers would be greatly improved if a sanitized (no sensitive material) version of the file could be shared, while still maintaining relationships.

Contributor guide

No contributing guide indexed for this repository

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

The issue does not name a file, test, or entry point. Start by locating configuration handling in the Autograph codebase, then determine how to produce a sanitized representation that preserves relationships while excluding sensitive material; done should include an agreed scope and a way to verify the resulting configuration is safe to share.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.