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

docs: update windows powershell commands #4533

Merged
merged 2 commits into from
Dec 20, 2022
Merged

docs: update windows powershell commands #4533

merged 2 commits into from
Dec 20, 2022

Conversation

vimode
Copy link
Contributor

@vimode vimode commented Oct 19, 2022

What does this PR do?

Updated the windows powershell commands, in powershell a new line is done via backticks(`). The current guide uses commas(,) for new line instead.
The README.md has the correct commands but the README-CN.md has the incorrect command.

Current

docker run -it --rm ,
    --volume /var/run/docker.sock:/var/run/docker.sock ,
    --volume ${pwd}/appwrite:/usr/src/code/appwrite:rw ,
    --entrypoint="install" ,
    appwrite/appwrite:1.0.3

Updated with backticks.

docker run -it --rm `
    --volume /var/run/docker.sock:/var/run/docker.sock `
    --volume ${pwd}/appwrite:/usr/src/code/appwrite:rw `
    --entrypoint="install" `
    appwrite/appwrite:1.0.3

This aligns with the current proper installation instructions given in the README.md.

Related PRs and Issues

This has been discussed in #315
The same issue in the official docs which is updated in a PR at appwrite/docs/#291.

Have you added your change to the Changelog?

This doesn't change the codebase, so I don't think its needed to be added to changelog.

Have you read the Contributing Guidelines on issues?

Yes

@gewenyu99
Copy link

I think this exists in README.md, too, right?

Can we have this change in both places?

@vimode
Copy link
Contributor Author

vimode commented Oct 20, 2022

The code in the README.md uses the correct convention (uses backticks) for new line.

Copy link
Contributor

@stnguyen90 stnguyen90 left a comment

Choose a reason for hiding this comment

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

Hey 👋 awesome work on your PR! We've approved your work and it'll be merged soon!

@stnguyen90 stnguyen90 added the hacktoberfest-accepted Accepted for Hacktoberfest, will be merged later label Oct 29, 2022
@christyjacob4
Copy link
Member

@vimode can you please resolve the conflicts?

@vimode
Copy link
Contributor Author

vimode commented Dec 19, 2022

@christyjacob4 I have resolved the merge conflicts.

@christyjacob4 christyjacob4 merged commit 8fdafdc into appwrite:master Dec 20, 2022
@christyjacob4
Copy link
Member

THANK YOU! All changes merged 🥳

Please reach out to me on our Discord server if you would like to claim your Appwrite swags! As a way of saying thank you, we would also love to invite you to join the Appwrite organization on GitHub. Please share your GitHub username with us on Discord.  

You can accept the invite by visiting https://github.com/orgs/appwrite/invitation. By joining our team, you will officially be an Appwrite maintainer on GitHub.

You can change your membership visibility settings, so your new Appwrite team membership badge will show up on your personal GitHub profile.

Please feel free to look for more PRs you might be interested in helping with on our long list of Hacktoberfest friendly issues and help make Appwrite better :)

@vimode vimode deleted the doc-windows-powershell-installation-new-line-fix branch December 20, 2022 10:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hacktoberfest-accepted Accepted for Hacktoberfest, will be merged later
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants