Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

engine: consolidate troubleshooting to single page #20039

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

dvdksn
Copy link
Contributor

@dvdksn dvdksn commented May 15, 2024

Description

The troubleshoot daemon page receives poor CSAT rating through our feedback widget. It seems that it's because users are having an issue for which there is documentation, but it's documented on a different page. This PR consolidates all troubleshooting instructions related to the daemon into a single page.

Preview: https://deploy-preview-20039--docsdocker.netlify.app/config/daemon/troubleshoot/

@dvdksn dvdksn requested a review from thaJeztah May 15, 2024 13:06
@github-actions github-actions bot added area/engine Issue affects Docker engine/daemon area/install Relates to installing a product area/configuration Relates to configuring containers area/storage Relates to storage, volumes labels May 15, 2024
Copy link

netlify bot commented May 15, 2024

Deploy Preview for docsdocker ready!

Name Link
🔨 Latest commit 3f587d1
🔍 Latest deploy log https://app.netlify.com/sites/docsdocker/deploys/665d78b0440af80008cb0c39
😎 Deploy Preview https://deploy-preview-20039--docsdocker.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

content/config/daemon/troubleshoot.md Outdated Show resolved Hide resolved
```

2. Configure the DNS servers manually using the
[Red Hat documentation](https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/6/html/Deployment_Guide/s1-networkscripts-interfaces.html).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this is linking to RHEL 6 docs, which is really old; I haven't read the link, but sounds like something that we should point to more current docs (and review if this content is still relevant 🤔)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated to a version 9 link... where the description for this seems more up to date.

{{< /tab >}}
{{< /tabs >}}

### Allow access to the remote API through a firewall
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps this is content that should be part of the "allow remote access" to the API 🤔

I'm slightly on the fence how much we should document this though, as exposing the API remotely is always a big security risk; more so because this section is thin on risks (e.g. it mentions "or 2375 if you're not using TLS - which effectively means "give the world root access" 😬) 🤔

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah... I moved this section to the more appropriate doc (not really troubleshooting). That doc contains a strong warning about this already.

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
@dvdksn dvdksn force-pushed the freshness-daemon-troubleshoot branch from e68c73f to 3f587d1 Compare June 3, 2024 08:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/configuration Relates to configuring containers area/engine Issue affects Docker engine/daemon area/install Relates to installing a product area/storage Relates to storage, volumes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants