Skip to content

refactor: name the sample files and the mesh ingress docs Ascender - #59

Merged
cigamit merged 1 commit into
ctrliq:develfrom
blaipr:refactor/name-the-sample-files-ascender
Sep 17, 2026
Merged

cigamit merged 1 commit into
ctrliq:develfrom
blaipr:refactor/name-the-sample-files-ascender

Conversation

@blaipr

@blaipr blaipr commented Sep 16, 2026

Copy link
Copy Markdown
Contributor

The first thing the README tells a reader to run is kubectl apply -f awx-demo.yml, and that file creates an AWX named awx-demo. Everything else a new deployment touches is Ascender now, so the sample that introduces the operator should be too.

The samples

  • awx-demo.yml → ascender-demo.yml, declaring an Ascender in ascender.ansible.com
  • awxmeshingress-demo.yml → ascendermeshingress-demo.yml, an AscenderMeshIngress pointing at ascender-demo
  • the README points at both, and a comment in the installer defaults offering awx-demo.example.com now matches the sample it refers to

The mesh ingress docs were left half converted

#50 moved the apiVersion and kind rows of the reference table to Ascender, but not the AWXMeshIngressSpec, AWXMeshIngressStatus and AWXMeshIngressList rows beside them, nor the headings those rows link to. A table saying kind: AscenderMeshIngress and then linking to AWXMeshIngressSpec is worse than either end of it.

All 26 occurrences move together, anchors included: #awxmeshingressspec and friends would otherwise have pointed at headings that no longer exist. Checked afterwards that every in-page link still resolves to a heading, and mkdocs build --strict passes.

One deletion

docs/awx-demo.svg, an 844 KB terminal recording that nothing references. It shows an install of awx-operator.yaml producing a pod named awx-operator-7dbf9db9d7-z62pm, which cannot happen any more after #54. It stays in git history if anyone wants it back.

What is deliberately untouched

The awx.ansible.com CRDs, their kustomization entries and the CSV: that group is served on purpose so existing deployments keep working, and the sample moving to Ascender does not change that.

The first thing the README tells a reader to run is
`kubectl apply -f awx-demo.yml`, and that file creates an AWX named
awx-demo. Every other surface a new deployment touches is Ascender now,
so the sample that introduces the operator should be too.

awx-demo.yml becomes ascender-demo.yml and declares an Ascender in
ascender.ansible.com, which is what a new deployment should be.
awxmeshingress-demo.yml follows, and the README points at both.

The mesh ingress documentation was left half converted: ctrliq#50 moved the
apiVersion and kind rows of its reference table to Ascender but not the
AWXMeshIngressSpec, AWXMeshIngressStatus and AWXMeshIngressList rows
beside them, nor the headings those rows link to. All twenty six move
together, anchors included, and every in page link still resolves.

docs/awx-demo.svg goes. It is an 844 kilobyte terminal recording that
nothing references, showing an install of awx-operator.yaml producing a
pod named awx-operator-7dbf9db9d7-z62pm: a workflow that cannot happen
any more. It stays in the history if anyone wants it back.

A comment in the installer defaults offered awx-demo.example.com as an
example hostname, which now matches the sample it refers to.
@ciq-it-service-account

ciq-it-service-account commented Sep 16, 2026 •

Copy link
Copy Markdown

✅ Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
✅ Open Source Security 0 0 0 0 0 issues
✅ Licenses 0 0 0 0 0 issues
✅ Code Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@cigamit cigamit self-assigned this Sep 17, 2026
@cigamit
cigamit merged commit a611da5 into ctrliq:devel Sep 17, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Development

Successfully merging this pull request may close these issues.

3 participants