Commit Graph

11 Commits

Author SHA1 Message Date
Igor Aleksandrov c3431b0474
Rails guide upgrade (part 2) (#22114)
## 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](https://docs.docker.com/guides/php/configure-ci-cd/),
[Go](https://docs.docker.com/guides/golang/),
[Python](https://docs.docker.com/guides/python/) and others, including,
of course, Ruby itself.

Each of these guides currently has a [Configure
CI/CD](https://docs.docker.com/guides/python/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:

1. 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).

2. 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**
<img width="1512" alt="Screenshot 2025-02-27 at 11 26 39"
src="https://github.com/user-attachments/assets/1ca06aea-ffeb-4efb-a14d-27254d2a2110"
/>

**After** 
<img width="1512" alt="Screenshot 2025-02-27 at 11 26 01"
src="https://github.com/user-attachments/assets/7abbe8b7-d1b3-480f-8105-49f967b51e47"
/>

## Related issues or tickets

#21559

## Reviews

- [x] Technical review
- [x] Editorial review
- [ ] Product review
2025-03-12 08:08:51 -07:00
Ville Skyttä ae3eec2c70
docs: grammar and spelling fixes (#22136)
<!--Delete sections as needed -->

## Description

<!-- Tell us what you did and why -->

Fix a few grammar and spelling errors.


## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
2025-02-28 14:13:37 -08:00
Igor Alexandrov 98972aa72d Added libyaml-dev to the Rails Dockerfile example 2025-01-15 10:52:03 +04:00
Igor Aleksandrov d7ffb99825
Rails guide upgrade (part 1) (#21559)
## Description

This PR upgrades the Rails framework guide and covers the application
containerization step. In the following PRs, I will update the section
about deploying with Docker Compose, and add a new "Deployment with
Kamal" section.

## Reviews

- [ ] Technical review
- [x] Editorial review
- [ ] Product review
2025-01-14 11:09:18 +01:00
David Karlsson b2264d26cb guides: add cross-references to gha intro guide
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-12-06 12:55:49 +01:00
CrazyMax e6d3d21f9b
gha: move docker login step up
Signed-off-by: CrazyMax <1951866+crazy-max@users.noreply.github.com>
2024-11-30 22:44:56 +01:00
Allie Sadler 99a24c4a6b
ENGDOCS-2300 (#21354)
<!--Delete sections as needed -->

## Description

Final PR to improve the DD IA. 

Validate test failing due to link that needs fixing in an upstream repo 

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review

---------

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-11-07 14:45:53 +00:00
David Karlsson 56e58ae5bf site: rework guides filters and tags taxonomy
- Rework the filtering system for guides to drop the use of the
  "products", "subjects", and "levels" taxonomies in favor of "tags" and
  "languages"
- This change means that the existing taxonomy functionality integrates
  better with the guides filtering, and there are fewer parameters to
  keep in mind when adding metadata to a guide
  - Only two taxonomies instead of three
  - Only one of those taxonomies are guides-specific (languages)
  - The other taxonomy (tags) works for all content
- Updates how tags and tag pages are rendered in general

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-10-28 16:10:20 +01:00
David Karlsson c8d77aeb2e guides: shorten summaries
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-10-07 12:42:37 +02:00
David Karlsson 4238c62877 chore: add aliases, run formatter
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-10-03 17:20:16 +02:00
David Karlsson 2e59bd4eb7 site: use filter-based nav for guides
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-10-03 16:50:15 +02:00