Rails guide upgrade (part 2) #22114
Merged
Rails guide upgrade (part 2) #22114
+121
−142
Conversation
This file contains 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
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
craig-osterhout
requested changes
Mar 7, 2025
There was a problem hiding this comment.
Overall, LGTM.
I left one small comment for a formatting nit.
In addition, the text in the Next steps sections needs to be updated to reflect the new topic order for the following topics:
configure-github-actions.mddevelop.mdcontainerize.md
For example, in containerize.md, change In the next section, you'll learn how you can develop your application using containers. to something like In the next section, you'll take a look at how to set up a CI/CD pipeline using GitHub Actions.
|
Thanks, @craig-osterhout. I updated the markup and changed the wording in "Next steps" sections. |
craig-osterhout
approved these changes
Mar 12, 2025
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.
Description
This PR has two goals. First of all it continues work that has been done in #21559. Besides this, and this is more significant, I tried to improve the structure of the documentation that is currently used for different language-specific guides like PHP, Go, Python and others, including, of course, Ruby itself.
Each of these guides currently has a Configure CI/CD section. Inside this section there is a GitHub Actions workflow example that has nothing in common with a CI/CD pipeline. It's just an example of how to build and push an image to a Docker Hub registry. We should be clear in our documentation and not mislead our users. This was the main reason why I renamed this section to "Automate your builds with GitHub Actions". I also updated the content of this section to reflect the new name and to make it more clear what the user can expect from this guide. I suggest the same be done for all other language-specific guides.
Besides this, I changed the order of the sections in the Ruby guide. The "Develop your app" section has been moved down to the bottom of the guide. This makes more sense to me because of two reasons:
It is more important to start using Docker Hub right after you added the Dockerfile to your project (section number one in all language-specific guides).
I can hardly imagine anybody using Docker to run the app locally for development purposes (at least for Ruby). What is really essential and useful is to know how to run services, that are required by your app, like a database, a cache server, or a local LLM. This is why the "Develop your app" section should be rewritten to explain how to run the infrastructure services that are required by the app and not the app itself.
Below there are screenshots reflecting the changes that have been made in this PR.
Before
After
Related issues or tickets
#21559
Reviews