Skip to content

Conversation

@stb13579
Copy link
Contributor

@stb13579 stb13579 commented Apr 5, 2022

What does it do?

Added callout to clarify that Strapi is not currently providing a Docker image for v4 and a link to a Community solution.

Why is it needed?

Describe the issue you are solving.

Related issue(s)/PR(s)

#826

@stb13579 stb13579 added source: Dev Docs PRs/issues targeting the Developer Docs issue: doc request Issues that require adding new content, possibly with some prior research pr: updated content PRs updating existing documentation content target: v4 Documentation PRs/issues targeting content from docs.strapi.io (main branch). size: small If the PR includes only 1 file with <10 lines of text or a small code fix labels Apr 5, 2022
@vercel
Copy link

vercel bot commented Apr 5, 2022

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/strapijs/documentation/93epXVfeVXCHNfPaTxQQGBJzZxqi
✅ Preview: https://documentation-git-dev-docker-update-strapijs.vercel.app

@stb13579
Copy link
Contributor Author

stb13579 commented Apr 5, 2022

Hello! This PR is for consistency with the readme file update by @alexandrebodin .

@rowild
Copy link
Contributor

rowild commented Apr 5, 2022

A callout is not enough. The current documentation does not lead to a successful installation of strapi v3 with docker. The relevant docs, which include further steps necessary, are at
https://github.com/strapi/strapi-docker
to which there is simply no link/note/mention at all.

The status quo of this page leads to a very unsatisfying experience. That's not at all stapi stands for.
Please improve! Thank you!

@stb13579
Copy link
Contributor Author

stb13579 commented Apr 5, 2022

A callout is not enough. The current documentation does not lead to a successful installation of strapi v3 with docker. The relevant docs, which include further steps necessary, are at https://github.com/strapi/strapi-docker to which there is simply no link/note/mention at all.

The status quo of this page leads to a very unsatisfying experience. That's not at all stapi stands for. Please improve! Thank you!

Hi @rowild. Thanks for your feedback. We are trying to not add any additional v3 documentation to the v4 docs. Do I understand your request correctly, that you want us to update the v3 Docker documentation?

@rowild
Copy link
Contributor

rowild commented Apr 5, 2022

@StrapiShaun I know that you do not support anything with v3 anymore, and that is understandable (even though I would say that, as long as there is no strapi v4 docker available, v3 should still get attention).

However, IMO existing documentation should at least lead to a working setup. Therefore I would like to suggest to add a link to the strapi docker github repo, where there is definitely more information available should it be needed. This could easily be done by simply adding a new paragraph after the docker-composer up section saying something l ink this:

"If you need further information, please refer to the strapi-docker readme."

IMO, that should be there anyway, also, when a v4 edition should be released.

Thank you!

Copy link
Collaborator

@pwizla pwizla left a comment

Choose a reason for hiding this comment

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

LGTM, Shaun, thanks for taking care of this :-)

Just a minor question about the link "style", in the comments.

@rowild
Copy link
Contributor

rowild commented Apr 25, 2022

If I see that correctly you intend to keep an installation guide for a v3 feature in the v4 documentation? Why, if so?

@vercel
Copy link

vercel bot commented Apr 26, 2022

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
documentation ✅ Ready (Inspect) Visit Preview Apr 26, 2022 at 4:21PM (UTC)

@stb13579
Copy link
Contributor Author

If I see that correctly you intend to keep an installation guide for a v3 feature in the v4 documentation? Why, if so?

Hello @rowild, We think it is necessary to have the callout now to reduce confusion. We are still exploring options for how to treat Docker in the documentation and waiting for additional feedback from our Product and Engineering teams.

@rowild
Copy link
Contributor

rowild commented Apr 26, 2022

@StrapiShaun Yes, I know, the callout was my idea after all. However, it is simply inconsistent to have a v3 workflow in a v4 docu. Really, I do not know, why strapi decides to do so? I work with many CMSs and it is common to link to an old instruction if necessary, but not to provide one in a wrong context. This case is absolutely such a situation: link to v3 as long as there is nothing for v4. THAT would remove confusion once and for all. Not only a callout.

Or what am I missing?

@stb13579
Copy link
Contributor Author

@rowild. We are aware that the Docker documentation is imperfect. We have decided to make this minimally viable change in the short term while we discuss how to handle it going forward.

@rowild
Copy link
Contributor

rowild commented Apr 26, 2022

@StrapiShaun No offense, but what is sooooooo difficult to delete superfluous text? If it wasn't a copy from v3, it wouldn't be there anyway, since nobody would have written it...???

@derrickmehaffy
Copy link
Member

@StrapiShaun No offense, but what is sooooooo difficult to delete superfluous text? If it wasn't a copy from v3, it wouldn't be there anyway, since nobody would have written it...???

@rowild I believe this discussion is not moving in a productive way, I wish to remind you of our Community Code of Conduct, specifically the following sections:

As part of our responsibilities I am giving you an official warning as a Strapi employee that your conduct is not falling within what we believe to be correct behavior. You may disagree with our decisions, and we respect that, but we have made these decisions with the information we have.

If you have concerns that you wish to address in private I am happy to schedule a call with you one on one, just email community@strapi.io and I will schedule something.

@stb13579 stb13579 merged commit 0def274 into main Apr 27, 2022
@stb13579 stb13579 deleted the dev/Docker-update branch April 27, 2022 13:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

issue: doc request Issues that require adding new content, possibly with some prior research pr: updated content PRs updating existing documentation content size: small If the PR includes only 1 file with <10 lines of text or a small code fix source: Dev Docs PRs/issues targeting the Developer Docs target: v4 Documentation PRs/issues targeting content from docs.strapi.io (main branch).

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants