Conversation
Created 3 new partials, split the docker compose sample into multiple snippets
✅ Deploy Preview for brilliant-pasca-3e80ec ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
🚀 Performance Test ResultsTest Configuration:
Test Metrics:
📜 Logs |
Contributor
melissahenderson
left a comment
There was a problem hiding this comment.
I've commented on your pieces, but reading through, there were a few other thoughts I had. We can't comment in the file on things that haven't changed.
- The table and note in the Domains and subdomains setup section is basically the same as what's in the Update DNS records section. Could these two somehow be consolidated?
- For the Domains and subdomains setup table, if the "function" column was renamed "Exposes", then the use of "exposes" in each description could come out.
- All tables should use consistent capitalization in the headers.
- Might need a dev's feedback, but I was thinking about how usable the code block is in the Set up symbolic links section. Could you copy the whole code block (as it's set up today) and paste it into the terminal and have it work? If yes, we're good. If no, then each command should be in its own code block.
- Fix environment variable tables (required first, then alphabetical) - Spelling/wording fixes - Created Kratos warning partial, removed redundant content across the site - Expand maxHeadingLevel to H4 - Created heading for complete example
- Consolidate "Domain and subdomains setup" and "Update DNS records", renaming to "Domain and DNS configuration" - Updated domain/DNS table to change second column from "Function" to "Exposes" and then removed redundancy of "exposes an/the..." - Revised all table headings to follow the same capitalization scheme
melissahenderson
approved these changes
Apr 28, 2025
bosbaber
pushed a commit
to bosbaber/rafiki
that referenced
this pull request
May 16, 2025
* docs: update docker compose Created 3 new partials, split the docker compose sample into multiple snippets * docs: feedback updates - Fix environment variable tables (required first, then alphabetical) - Spelling/wording fixes - Created Kratos warning partial, removed redundant content across the site - Expand maxHeadingLevel to H4 - Created heading for complete example * docs: feedback updates - Consolidate "Domain and subdomains setup" and "Update DNS records", renaming to "Domain and DNS configuration" - Updated domain/DNS table to change second column from "Function" to "Exposes" and then removed redundancy of "exposes an/the..." - Revised all table headings to follow the same capitalization scheme
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
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.
Adding 3 partials (copied from existing partials with Helm column and default column rermoved, and a-z order):
Changing all instances of “Compose” to capitalized (based on usage from official Docker docs)
Split the Docker Compose file into multiple pieces by services
Fixes #3379