Skip to content

Additional Docker for Windows documentation added #12877

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

Closed
wants to merge 4 commits into from

Conversation

SetTrend
Copy link

Proposed changes

I merged my previous pull requests for improving Docker for Windows documentation into this single pull request.

It seems to me that approving Docker for Windows documentation is stalling quite a bit. So, instead of submitting numerous amendments to the current documentation I now turned to unite my additions into this single pull request here to keep the administrative efforts at a minimum for me while still sharing the additional information through the preview website auto-generated by this pull request.

Related pull requests

#12876
#12796

SetTrend added 2 commits May 21, 2021 01:21
- One paragraph was double, so I merged these two.
- Reasoning added to note on context-less effects.
@netlify
Copy link

netlify bot commented May 20, 2021

Deploy Preview for docsdocker ready!

Built with commit e12c58f

https://deploy-preview-12877--docsdocker.netlify.app

@SetTrend SetTrend force-pushed the docker-for-windows branch 4 times, most recently from 24ccc6f to 5e9f296 Compare May 21, 2021 01:07
@SetTrend SetTrend force-pushed the docker-for-windows branch from 5e9f296 to e12c58f Compare May 21, 2021 01:14
@usha-mandya usha-mandya requested a review from StefanScherer May 21, 2021 09:17
@usha-mandya usha-mandya added the area/desktop Issue affects a desktop edition of Docker. E.g docker for mac label May 21, 2021
@StefanScherer
Copy link
Member

Hi @SetTrend
Thank you very much for this huge contribution! 😍
We're reviewing your page at the moment. I would love to get this into our docs.

For other reviewers: The new page can be found at https://deploy-preview-12877--docsdocker.netlify.app/docker-for-windows/mounts-on-windows/

Copy link
Member

@StefanScherer StefanScherer left a comment

Choose a reason for hiding this comment

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

A first quick review.
We have to decide where to put the mounts-on-windows page. 🤔
Nice way to show examples for Windows users using the PowerShell. 😄
Really useful diagram for Windows. 🎉

toc_min: 1
toc_max: 2
redirect_from:
- /engine/admin/volumes/mounts-on-windows/
Copy link
Member

Choose a reason for hiding this comment

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

I'm not sure we need this redirect.

@@ -365,6 +365,8 @@ guides:
title: Volumes
- path: /storage/bind-mounts/
title: Bind mounts
- path: /docker-for-windows/mounts-on-windows/
Copy link
Member

Choose a reason for hiding this comment

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

For me it feels like the page path should be /storage/mounts-on-windows/ as it's listed in the storage section and not in the docker-for-windows section.
@usha-mandya WDYT?
I understand that this page is specific to Docker Desktop for Windows, so it may be listed there as well? 🤔

Copy link
Member

Choose a reason for hiding this comment

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

Agree. We can add a link to this page from the Docker Desktop for Windows page.

Copy link
Author

Choose a reason for hiding this comment

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

I'm a bit uncertain about whether I am supposed to change something at this stage. To me it looks like you're still in an internal discussion?

I'll gladly change things to your discretion (or leave it up to you, of course). Just address me imperatively when you feel it's time I can do something to amend the PR.

@SetTrend
Copy link
Author

@StefanScherer: Do you believe we'll get any progress here?

@SetTrend
Copy link
Author

Ping.

@StefanScherer
Copy link
Member

Hey @SetTrend I'm sorry for the delay. Thanks again for you enthusiasm to write down all the details for Windows.

Our docs team an PMs came to the conclusion that we don't want to add all these details to our docs, because it would be hard to maintain it and keep it in sync if our engineering team decides to change the internals of Docker Desktop.
We also have discussions about the pros and cons of adding PowerShell to all examples, but have another approach in mind that will be easier to maintain across all the docs pages.

Maybe it's better for now that you put these details in a blog post and share it with the community?

@SetTrend
Copy link
Author

Very disappointing ...

Would you mind if I took my version of the whole documentation as a base and publish it on my website, focussing Windows developers? Introduced by a corresponding disclaimer, of course?

@StefanScherer
Copy link
Member

Sorry about the delay. I still would recommend to write a detailed blog post to share it with your community. The docs repo is Apache licensed, please refer to that what you can do. I just wonder how you plan to keep it in sync with upstream changes when you host them on a different site.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/desktop Issue affects a desktop edition of Docker. E.g docker for mac
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants