Add awx-logos instructions to Docker development setup docs#16353
Open
manasvi-sahare wants to merge 1 commit intoansible:develfrom
Open
Add awx-logos instructions to Docker development setup docs#16353manasvi-sahare wants to merge 1 commit intoansible:develfrom
manasvi-sahare wants to merge 1 commit intoansible:develfrom
Conversation
📝 WalkthroughWalkthroughThis change adds documentation to the Docker Compose README explaining how to obtain and use AWX branding assets from the awx-logos repository. A new section includes instructions and a Bash command snippet for cloning the logos repository. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment Tip You can disable sequence diagrams in the walkthrough.Disable the |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@tools/docker-compose/README.md`:
- Around line 44-46: Replace the incorrect opening code fence "'''bash" with a
proper Markdown backtick fence "```bash" and add a closing fence "```" after the
git clone line (the line containing "git clone
https://github.com/ansible/awx-logos.git") so the block starts with ```bash and
ends with ```; ensure there are no stray single-quote fences remaining.
- Around line 40-46: Update the "AWX Logos" README section to specify exactly
where to clone the awx-logos repo (e.g., as a sibling directory named awx-logos
next to the AWX repo) and explain its purpose: that the repo contains branding
assets used only when building or developing the UI on the host, not required
for normal Docker Compose runtime unless you rebuild UI images. Instruct how to
make the assets available when needed—either by mounting or symlinking the
awx-logos directory into the docker-compose assets path or by copying required
files into the UI build context—and note any additional setup steps (e.g., run
the UI build or restart compose) and when cloning is optional vs mandatory.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 0a245704-f6be-4548-a166-634db309bdec
📒 Files selected for processing (1)
tools/docker-compose/README.md
Comment on lines
+40
to
+46
| ### AWX Logos | ||
| AWX uses branding assets provided by the 'awx-logos' repository. | ||
| Clone the repo before starting development environment: | ||
|
|
||
| '''bash | ||
| git clone https://github.com/ansible/awx-logos.git | ||
|
|
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Description: Check Docker Compose files for awx-logos volume mounts and references
# Check docker-compose.yml for awx-logos references
echo "=== Checking docker-compose files for awx-logos references ==="
fd -e yml -e yaml . tools/docker-compose --exec rg -l 'awx-logos'
# Check for volume mount configurations
echo -e "\n=== Checking for volume mount configurations ==="
fd docker-compose.yml tools/docker-compose --exec cat {}
# Check inventory file for awx-logos configuration
echo -e "\n=== Checking inventory file ==="
cat tools/docker-compose/inventory 2>/dev/null | rg -A2 -B2 'logo'Repository: ansible/awx
Length of output: 12903
🏁 Script executed:
# Check the full README.md around the lines in question
cat -n tools/docker-compose/README.md | head -60
# Search for all awx-logos references in the entire codebase
rg 'awx-logos' --type md --type txt --type yamlRepository: ansible/awx
Length of output: 3547
🏁 Script executed:
# Search for awx-logos in Dockerfile, Makefile, and build-related files
rg 'awx.logos|awx-logos' tools/ --type dockerfile --type makefile -A 3 -B 1
# Check .gitignore for awx-logos
rg 'awx.logos|awx-logos' .gitignore
# Search in ansible playbooks
fd '\.yml$|\.yaml$' tools/ | xargs rg 'awx.logos|awx-logos' 2>/dev/null
# Search in Python files that might configure paths
rg 'awx.logos|awx-logos' tools/ --type pyRepository: ansible/awx
Length of output: 89
🏁 Script executed:
# Search for awx-logos in all files
rg 'awx.logos|awx-logos' tools/ -A 3 -B 1
# Check if Dockerfile exists and search it
find . -name 'Dockerfile*' -exec rg 'awx.logos|awx-logos' {} +
# Check Makefile and build scripts
find . -name 'Makefile*' -o -name '*.mk' | xargs rg 'awx.logos|awx-logos' 2>/dev/null
# Check .gitignore
cat .gitignore | rg 'awx.logos|awx-logos'
# Search in Python files more broadly
rg 'awx.logos|awx-logos|logo' --type py tools/ | head -20Repository: ansible/awx
Length of output: 559
Clarify where to clone awx-logos and why it's needed for the Docker Compose setup.
The instruction to clone awx-logos doesn't specify the target directory or explain how it's used in the development environment. Since awx-logos isn't referenced in the Docker Compose configuration, clarify whether:
- Developers should clone it as a sibling directory, relative to the AWX repo, or elsewhere
- The clone is required for the Docker Compose workflow or only needed for UI development on the host machine
- Any additional setup steps are required to make the logos available to the development environment
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@tools/docker-compose/README.md` around lines 40 - 46, Update the "AWX Logos"
README section to specify exactly where to clone the awx-logos repo (e.g., as a
sibling directory named awx-logos next to the AWX repo) and explain its purpose:
that the repo contains branding assets used only when building or developing the
UI on the host, not required for normal Docker Compose runtime unless you
rebuild UI images. Instruct how to make the assets available when needed—either
by mounting or symlinking the awx-logos directory into the docker-compose assets
path or by copying required files into the UI build context—and note any
additional setup steps (e.g., run the UI build or restart compose) and when
cloning is optional vs mandatory.
Comment on lines
+44
to
+46
| '''bash | ||
| git clone https://github.com/ansible/awx-logos.git | ||
|
|
There was a problem hiding this comment.
Fix the Markdown code fence syntax.
The code fence uses single quotes ('''bash) instead of backticks and is missing a closing fence. This will cause incorrect rendering of the code block.
🐛 Proposed fix for the code fence
-'''bash
+```bash
git clone https://github.com/ansible/awx-logos.git
+```📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| '''bash | |
| git clone https://github.com/ansible/awx-logos.git |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@tools/docker-compose/README.md` around lines 44 - 46, Replace the incorrect
opening code fence "'''bash" with a proper Markdown backtick fence "```bash" and
add a closing fence "```" after the git clone line (the line containing "git
clone https://github.com/ansible/awx-logos.git") so the block starts with
```bash and ends with ```; ensure there are no stray single-quote fences
remaining.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds documentation for cloning the awx-logos repository when using the
Docker development environment.
The AWX UI depends on branding assets provided by the awx-logos repository,
but the current documentation does not mention this step. This change adds
instructions to clone the repository so developers can properly set up the
environment without missing assets.
Fixes #11593
Issue Type
Component Name
-Docs
Steps to reproduce and extra info
-The Docker development documentation does not currently mention cloning the
awx-logos repository. This may lead to missing branding assets when running
AWX locally. This change adds a short section explaining that the awx-logos repository
should be cloned before starting the development environment.
Summary by CodeRabbit