Improve the readme #35691

clivinghouse · 2022-12-09T05:58:25Z

Signed-off-by: chl5158 79345446+clivinghouse@users.noreply.github.com

Summary

This is my first pull req. I have skimmed over the requirements to contribute to this project, I believe I have met the projects requirements. Please let me know if I have missed anything! I have only made some grammatical edits. Couple added periods here, some sentence restructuring there.

TODO

Review of grammar.
make sure edits don't misconstrue previous meanings.

Checklist

~~- Code is properly formatted~~ N/A

Sign-off message is added to all commits
~~- [X ] Tests (unit, integration, api and/or acceptance) are included~~ N/A
~~- [ ] Screenshots before/after for front-end changes~~ No Changes
~~- [ ] Documentation (manuals or wiki) has been updated or is not required~~ Directly changing docs N/A
~~- [ ] Backports requested where applicable (ex: critical bugfixes)~~ N/A

Signed-off-by: chl5158 <79345446+clivinghouse@users.noreply.github.com>

clivinghouse · 2022-12-09T19:51:36Z

@szaimen thank you for the title improvement!

README.md

come-nc · 2022-12-12T08:58:31Z

README.md

- 🖥 [**Install** a server by yourself](https://nextcloud.com/install/#instructions-server) on your hardware or by using one of our ready to use **appliances**
- 📦 Buy one of the [awesome **devices** coming with a preinstalled Nextcloud](https://nextcloud.com/devices/)
- 🏢 Find a [service **provider**](https://nextcloud.com/providers/) who hosts Nextcloud for you or your company
+- ☑️ [**Simply sign up**](https://nextcloud.com/signup/) with one of our providers either through our website or through our apps directly.


Not our apps, the one of the providers I think

When the sentence talks about signing up, it gives the option of going to the Nextcloud signup page or through "... the apps directly..." i am assuming it means our IOS/Android app. is this sentence to mean

Suggested change

- ☑️ [**Simply sign up**](https://nextcloud.com/signup/) with one of our providers either through our website or through our apps directly.

- ☑️ [**Simply sign up**](https://nextcloud.com/signup/) with one of our providers either through our website or through the providers apps directly.

if it is to mean our IOS/Android App, then maybe it should be more consice

Suggested change

- ☑️ [**Simply sign up**](https://nextcloud.com/signup/) with one of our providers either through our website or through our apps directly.

- ☑️ [**Simply sign up**](https://nextcloud.com/signup/) with one of our providers either through our website or through our IOS and Android apps directly.

No, the change is correct, it's OUR apps (android, iOS, desktop) through which you can sign up with a third party provider ;-) So this is actually good.

Suggested change

- ☑️ [**Simply sign up**](https://nextcloud.com/signup/) with one of our providers either through our website or through our apps directly.

☑️ [**Simply sign up**](https://nextcloud.com/signup/) with one of our providers either through our website or through apps (Android, iOS, Desktop) directly.

would this be good then? @jospoortvliet

README.md

come-nc · 2022-12-12T09:00:03Z

README.md

 6. 🎉 Wait for it to get merged!

-Third-party components are handled as git submodules which have to be initialized first. So aside from the regular git checkout invoking `git submodule update --init` or a similar command is needed, for details see Git documentation.
+Third-party components are handled as git submodules which have to be initialized first. Git checkout invoking `git submodule update --init` or a similar command is needed, for details see [Git documentation](https://git-scm.com/docs/user-manual).


The sentence lost its meaning, it was only missing a comma after «invoking»

I can see your point.

Suggested change

Third-party components are handled as git submodules which have to be initialized first. Git checkout invoking `git submodule update --init` or a similar command is needed, for details see [Git documentation](https://git-scm.com/docs/user-manual).

Third-party components are handled as git submodules which have to be initialized first. So aside from the regular git checkout invoking, `git submodule update --init` or a similar command is needed. For details see [Git documentation](https://git-scm.com/docs/user-manual).

Do you agree to adding a link to the git documentation?

I think that's fine.

But in what you propose, you put the comma wrong. People need to invoke the command 'git submodule' etc, so the coma should be after 'checkout', not after invoking:

So aside from the regular git checkout, invoking git submodule update --init or a similar command is needed. For details see Git documentation

Suggested change

Third-party components are handled as git submodules which have to be initialized first. Git checkout invoking `git submodule update --init` or a similar command is needed, for details see [Git documentation](https://git-scm.com/docs/user-manual).

Third-party components are handled as git submodules which have to be initialized first. So aside from the regular git checkout, invoking `git submodule update --init` or a similar command is needed. For details see [Git documentation](https://git-scm.com/docs/user-manual).

so like this @jospoortvliet?

clivinghouse · 2022-12-12T13:52:55Z

@come-nc, thank you for taking the time to look over my pull request. I am going to take a look at your corrections in a bit. I have to complete my finals today. Again, thank you for looking over this!

clivinghouse

Waiting for feedback from @come-nc.

clivinghouse · 2022-12-12T16:59:03Z

README.md

- 🖥 [**Install** a server by yourself](https://nextcloud.com/install/#instructions-server) on your hardware or by using one of our ready to use **appliances**
- 📦 Buy one of the [awesome **devices** coming with a preinstalled Nextcloud](https://nextcloud.com/devices/)
- 🏢 Find a [service **provider**](https://nextcloud.com/providers/) who hosts Nextcloud for you or your company
+- ☑️ [**Simply sign up**](https://nextcloud.com/signup/) with one of our providers either through our website or through our apps directly.


When the sentence talks about signing up, it gives the option of going to the Nextcloud signup page or through "... the apps directly..." i am assuming it means our IOS/Android app. is this sentence to mean

Suggested change

- ☑️ [**Simply sign up**](https://nextcloud.com/signup/) with one of our providers either through our website or through our apps directly.

- ☑️ [**Simply sign up**](https://nextcloud.com/signup/) with one of our providers either through our website or through the providers apps directly.

if it is to mean our IOS/Android App, then maybe it should be more consice

Suggested change

- ☑️ [**Simply sign up**](https://nextcloud.com/signup/) with one of our providers either through our website or through our apps directly.

- ☑️ [**Simply sign up**](https://nextcloud.com/signup/) with one of our providers either through our website or through our IOS and Android apps directly.

README.md

clivinghouse · 2022-12-12T17:10:07Z

README.md

 6. 🎉 Wait for it to get merged!

-Third-party components are handled as git submodules which have to be initialized first. So aside from the regular git checkout invoking `git submodule update --init` or a similar command is needed, for details see Git documentation.
+Third-party components are handled as git submodules which have to be initialized first. Git checkout invoking `git submodule update --init` or a similar command is needed, for details see [Git documentation](https://git-scm.com/docs/user-manual).


I can see your point.

Suggested change

Third-party components are handled as git submodules which have to be initialized first. Git checkout invoking `git submodule update --init` or a similar command is needed, for details see [Git documentation](https://git-scm.com/docs/user-manual).

Third-party components are handled as git submodules which have to be initialized first. So aside from the regular git checkout invoking, `git submodule update --init` or a similar command is needed. For details see [Git documentation](https://git-scm.com/docs/user-manual).

Do you agree to adding a link to the git documentation?

clivinghouse · 2023-02-01T17:23:09Z

since this was mentioned in the next release do i need to have this reviewed again @come-nc?

come-nc · 2023-02-02T13:57:22Z

since this was mentioned in the next release do i need to have this reviewed again @come-nc?

No, readme is not really tied to releases to my knowledge.

LGTM :D Co-authored-by: clivinghouse <79345446+clivinghouse@users.noreply.github.com> Signed-off-by: Jos Poortvliet <jospoortvliet@gmail.com>

README.md

This is nice. Thank you! Co-authored-by: Jos Poortvliet <jospoortvliet@gmail.com> Signed-off-by: clivinghouse <79345446+clivinghouse@users.noreply.github.com>

I was not even aware of this. Thank you for the correction! Co-authored-by: Jos Poortvliet <jospoortvliet@gmail.com> Signed-off-by: clivinghouse <79345446+clivinghouse@users.noreply.github.com>

jospoortvliet

See my feedback - once merged/improved, I'm good with this and it can be merged!

Signed-off-by: clivinghouse <79345446+clivinghouse@users.noreply.github.com>

jospoortvliet · 2023-11-10T07:38:48Z

thanks @clivinghouse !!

Edits made

71223cd

Signed-off-by: chl5158 <79345446+clivinghouse@users.noreply.github.com>

szaimen added this to the Nextcloud 26 milestone Dec 9, 2022

szaimen added the 3. to review Waiting for reviews label Dec 9, 2022

szaimen requested a review from a team December 9, 2022 06:56

szaimen changed the title ~~Edits made~~ Improve the readme Dec 9, 2022

come-nc reviewed Dec 12, 2022

View reviewed changes

clivinghouse commented Dec 12, 2022

View reviewed changes

come-nc requested a review from jospoortvliet December 13, 2022 07:50

blizzz mentioned this pull request Feb 1, 2023

26.0.0 beta 2 #36484

Merged

Update README.md

9acbb45

LGTM :D Co-authored-by: clivinghouse <79345446+clivinghouse@users.noreply.github.com> Signed-off-by: Jos Poortvliet <jospoortvliet@gmail.com>

jospoortvliet reviewed Feb 2, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

jospoortvliet reviewed Feb 2, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

clivinghouse and others added 2 commits February 2, 2023 13:38

Update README.md

93ab7b3

This is nice. Thank you! Co-authored-by: Jos Poortvliet <jospoortvliet@gmail.com> Signed-off-by: clivinghouse <79345446+clivinghouse@users.noreply.github.com>

Update README.md

faa5fe3

I was not even aware of this. Thank you for the correction! Co-authored-by: Jos Poortvliet <jospoortvliet@gmail.com> Signed-off-by: clivinghouse <79345446+clivinghouse@users.noreply.github.com>

jospoortvliet requested changes Feb 2, 2023

View reviewed changes

clivinghouse added 2 commits February 2, 2023 18:32

Update README.md

87e5b44

Signed-off-by: clivinghouse <79345446+clivinghouse@users.noreply.github.com>

Update README.md

4270134

Signed-off-by: clivinghouse <79345446+clivinghouse@users.noreply.github.com>

skjnldsv mentioned this pull request Feb 23, 2023

26.0.0 beta 5 #36834

Merged

blizzz mentioned this pull request Mar 7, 2023

26.0.0 RC2 #37078

Merged

blizzz modified the milestones: Nextcloud 26, Nextcloud 27 Mar 9, 2023

jospoortvliet approved these changes Mar 26, 2023

View reviewed changes

This was referenced May 3, 2023

27.0.0 beta 1 #38038

Merged

27.0.0 beta 2 #38137

Closed

27.0.0 beta 2 #38139

Merged

blizzz mentioned this pull request May 17, 2023

27.0.0 RC1 #38341

Merged

blizzz modified the milestones: Nextcloud 27, Nextcloud 28 May 23, 2023

skjnldsv mentioned this pull request Nov 1, 2023

chore: 28.0.0 beta 1 #41228

Merged

blizzz mentioned this pull request Nov 6, 2023

28.0.0 beta 2 #41314

Merged

clivinghouse closed this Nov 10, 2023

clivinghouse deleted the README-edits branch November 10, 2023 04:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve the readme #35691

Improve the readme #35691

clivinghouse commented Dec 9, 2022 •

edited

Loading

clivinghouse commented Dec 9, 2022

come-nc Dec 12, 2022

clivinghouse Dec 12, 2022

jospoortvliet Feb 2, 2023

clivinghouse Feb 3, 2023

come-nc Dec 12, 2022

clivinghouse Dec 12, 2022

jospoortvliet Feb 2, 2023

jospoortvliet Feb 2, 2023

clivinghouse Feb 3, 2023

clivinghouse commented Dec 12, 2022

clivinghouse left a comment

clivinghouse Dec 12, 2022

clivinghouse Dec 12, 2022

clivinghouse commented Feb 1, 2023

come-nc commented Feb 2, 2023

jospoortvliet left a comment

jospoortvliet commented Nov 10, 2023

	- ☑️ [Simply sign up](https://nextcloud.com/signup/) with one of our providers either through our website or through our apps directly.
	- ☑️ [Simply sign up](https://nextcloud.com/signup/) with one of our providers either through our website or through the providers apps directly.

	- ☑️ [Simply sign up](https://nextcloud.com/signup/) with one of our providers either through our website or through our apps directly.
	☑️ [Simply sign up](https://nextcloud.com/signup/) with one of our providers either through our website or through apps (Android, iOS, Desktop) directly.

	Third-party components are handled as git submodules which have to be initialized first. Git checkout invoking `git submodule update --init` or a similar command is needed, for details see [Git documentation](https://git-scm.com/docs/user-manual).
	Third-party components are handled as git submodules which have to be initialized first. So aside from the regular git checkout invoking, `git submodule update --init` or a similar command is needed. For details see [Git documentation](https://git-scm.com/docs/user-manual).

Improve the readme #35691

Improve the readme #35691

Conversation

clivinghouse commented Dec 9, 2022 • edited Loading

Summary

TODO

Checklist

clivinghouse commented Dec 9, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

clivinghouse commented Dec 12, 2022

clivinghouse left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

clivinghouse commented Feb 1, 2023

come-nc commented Feb 2, 2023

jospoortvliet left a comment

Choose a reason for hiding this comment

jospoortvliet commented Nov 10, 2023

clivinghouse commented Dec 9, 2022 •

edited

Loading