Skip to content

Conversation

@aevesdocker
Copy link
Contributor

@aevesdocker aevesdocker commented Oct 4, 2024

Description

Adapts https://docs.google.com/document/d/1aMbLWzHKtIiWxOt1FarIRk-GUZVVIMUYwufYllohdIc/edit into our Guide format

Related issues or tickets

Reviews

  • Technical review
  • Editorial review
  • Product review

@netlify
Copy link

netlify bot commented Oct 4, 2024

Deploy Preview for docsdocker ready!

Name Link
🔨 Latest commit 99e9835
🔍 Latest deploy log https://app.netlify.com/sites/docsdocker/deploys/670e363584c2570008d19365
😎 Deploy Preview https://deploy-preview-21059--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.

Copy link
Contributor

@dvdksn dvdksn left a comment

Choose a reason for hiding this comment

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

The settings parameters are now documented twice: in this guide, and on the Configure Settings Management page. The descriptions are worded slightly differently. I think we should either have a canonical reference, or publish them in multiple places but from a single source/include. Duplicated, almost identical descriptions are bound to deviate further.

Copy link
Contributor

@sarahsanders-docker sarahsanders-docker left a comment

Choose a reason for hiding this comment

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

Left a few non-blocker comments and found one small typo, otherwise LGTM

@usha-mandya
Copy link
Member

Thanks @aevesdocker. This looks great. I've left some suggestions. Let me know if you have any questions

@aevesdocker
Copy link
Contributor Author

@dvdksn

The settings parameters are now documented twice

Yes this didn't sit right with me either. I've now removed the tables, merged the paragraphs together and pointed them to the right docs place

@dvdksn dvdksn marked this pull request as ready for review October 10, 2024 09:52
description: Learn how to onboard your company and take advantage of all of the Docker products and features.
levels: [intermediate]
params:
featured: true
Copy link
Contributor

Choose a reason for hiding this comment

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

Should this be a featured guide?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Well it is the first ever admin guide ✨ so perhaps it should be?
@usha-mandya, thoughts?

Copy link
Member

Choose a reason for hiding this comment

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

Yes. It should be a featured guide. The Docker Compose guide has most views compared to DBC and Scout. So, happy to move one of those to the guides collection.

Copy link
Member

@usha-mandya usha-mandya left a comment

Choose a reason for hiding this comment

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

:shipit:

@aevesdocker aevesdocker merged commit f90323e into docker:main Oct 15, 2024
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants