Terminology: Lowercase "architecture as code" used in prose (Appendix D, Ch 13, Ch 16)

Open Beginner friendly
#1,842 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
82/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
python
Domain
documentation

Research direction

Start by searching the listed occurrences in docs/appendix_templates_and_tools.md, docs/16_migration.md, docs/13_testing_strategies.md, 06_structurizr.md, 31_appendix_b_technical_architecture.md, and 19_management_as_code.md. Update the specified prose, docstrings, checklist items, alt text, and non-project-name hyphenated references while preserving URL slugs, file names, and branch names; verify no unintended lowercase or hyphenated references remain.

Written by the indexing model from the issue text.

Description

documentation language

Category: terminology
Severity: high

Problem

The Style Guide mandates always writing Architecture as Code with capital A/C. Docstrings, comments, checklist items, and image alt text repeatedly use lowercase "architecture as code". Examples:

  • """Automated assessment of existing infrastructure for architecture as code migration""" (appendix_templates_and_tools.md:35)
  • # architecture as code Migration Playbook for {assessment_results.get('organization_name', 'Organization')} (line 219)
  • - [ ] architecture as code foundation training for all team members (line 230)
  • - [ ] Continuous improvement architecture as code implementation (line 281)

Affected files

  • docs/appendix_templates_and_tools.md lines 35, 45, 76, 95, 196, 219, 230, 251, 281, 284
  • docs/16_migration.md lines 207, 215
  • docs/13_testing_strategies.md line 3 (image alt text)

Suggested fix

Replace all lowercase prose/docstring occurrences of "architecture as code" with Architecture as Code. Leave URL slugs, file names, and branch names (#architecture-as-code-general, 0002-use-terraform-for-architecture-as-code.md, workflows/architecture-as-code-pipeline.yml) unchanged. Also normalise "Architecture-as-Code" (hyphenated) in 06_structurizr.md:1278, 31_appendix_b_technical_architecture.md:67, 323, 19_management_as_code.md:59 where the reference is not to the FINOS project name.


Auto-generated by editorial review agent.

Dominant language
Python
Stars
4
Forks
0
PR merge metrics
No merged PRs in 30d

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.

More from Geonitab/architecture_as_code

All issues in Geonitab/architecture_as_code

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.