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.

Sign up for GitHub

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

Improve the readme #35691

Closed
wants to merge 6 commits into from
Closed

Improve the readme #35691

Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
71223cd
Edits made
clivinghouse Dec 9, 2022
9acbb45
Update README.md
jospoortvliet Feb 2, 2023
93ab7b3
Update README.md
clivinghouse Feb 2, 2023
faa5fe3
Update README.md
clivinghouse Feb 2, 2023
87e5b44
Update README.md
clivinghouse Feb 2, 2023
4270134
Update README.md
clivinghouse Feb 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 29 additions & 21 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![codecov](https://codecov.io/gh/nextcloud/server/branch/master/graph/badge.svg)](https://codecov.io/gh/nextcloud/server)
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/209/badge)](https://bestpractices.coreinfrastructure.org/projects/209)

**A safe home for all your data.**
**A safe home for all of your data.**
clivinghouse marked this conversation as resolved.
Show resolved Hide resolved

![](https://raw.githubusercontent.com/nextcloud/screenshots/master/files/Files%20Sharing.png)

Expand All @@ -12,49 +12,57 @@
* 📁 **Access your Data** You can store your files, contacts, calendars, and more on a server of your choosing.
* 🔄 **Sync your Data** You keep your files, contacts, calendars, and more synchronized amongst your devices.
* 🙌 **Share your Data** …by giving others access to the stuff you want them to see or to collaborate with.
* 🚀 **Expandable with hundreds of Apps** ...like [Calendar](https://github.com/nextcloud/calendar), [Contacts](https://github.com/nextcloud/contacts), [Mail](https://github.com/nextcloud/mail), [Video Chat](https://github.com/nextcloud/spreed) and all those you can discover in our [App Store](https://apps.nextcloud.com)
* 🚀 **Expandable with hundreds of Apps** ...like [Calendar](https://github.com/nextcloud/calendar), [Contacts](https://github.com/nextcloud/contacts), [Mail](https://github.com/nextcloud/mail), [Video Chat](https://github.com/nextcloud/spreed) and all those you can discover in our [App Store](https://apps.nextcloud.com).
* 🔒 **Security** with our encryption mechanisms, [HackerOne bounty program](https://hackerone.com/nextcloud) and two-factor authentication.

Do you want to learn more about how you can use Nextcloud to access, share and protect your files, calendars, contacts, communication & more at home and in your organization? [**Learn about all our Features**](https://nextcloud.com/athome/).
Do you want to learn more about how you can use Nextcloud to access, share and protect your files, calendars, contacts, communication and more at home and/or in your organization? [**Learn about all our Features**](https://nextcloud.com/athome/).
clivinghouse marked this conversation as resolved.
Show resolved Hide resolved

## Get your Nextcloud 🚚

- ☑️ [**Simply sign up**](https://nextcloud.com/signup/) at one of our providers either through our website or through the apps directly.
- 🖥 [**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.
Copy link
Contributor

Choose a reason for hiding this comment

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

Not our apps, the one of the providers I think

Copy link
Author

Choose a reason for hiding this comment

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

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.

Copy link
Member

Choose a reason for hiding this comment

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

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.

Copy link
Author

Choose a reason for hiding this comment

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

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

- 🖥 [**Install**](https://nextcloud.com/install/#instructions-server) a server by yourself on your hardware.
jospoortvliet marked this conversation as resolved.
Show resolved Hide resolved
- 📦 Buy one of the awesome [**devices listed here**](https://nextcloud.com/devices/) with Nextcloud preinstalled.
- 🏢 Find a [**service provider**](https://nextcloud.com/providers/) who can host Nextcloud for you or for your company.

Enterprise? Public Sector or Education user? You may want to have a look into [**Nextcloud Enterprise**](https://nextcloud.com/enterprise/) provided by Nextcloud GmbH.
Are you in the Private Sector, Public Sector, or Education? You may want to have a look into [**Nextcloud Enterprise**](https://nextcloud.com/enterprise/) provided by Nextcloud GmbH.

## Get in touch 💬

* [📋 Forum](https://help.nextcloud.com)
* [👥 Facebook](https://www.facebook.com/nextclouders)
* [🐣 Twitter](https://twitter.com/Nextclouders)
* [🐘 Mastodon](https://mastodon.xyz/@nextcloud)
- [📋 Forum](https://help.nextcloud.com)
- [👥 Facebook](https://www.facebook.com/nextclouders)
- [🐣 Twitter](https://twitter.com/Nextclouders)
- [🐘 Mastodon](https://mastodon.xyz/@nextcloud)
clivinghouse marked this conversation as resolved.
Show resolved Hide resolved

You can also [get support for Nextcloud](https://nextcloud.com/support)!
You can also [get support from Nextcloud](https://nextcloud.com/support)!
clivinghouse marked this conversation as resolved.
Show resolved Hide resolved


## Join the team 👪

There are many ways to contribute, of which development is only one! Find out [how to get involved](https://nextcloud.com/contribute/), including as a translator, designer, tester, helping others, and much more! 😍
There are many ways to contribute. Find out [how to get involved](https://nextcloud.com/contribute/),
- Translator
- Designer
- Tester
- Community support

and much more... 😍
clivinghouse marked this conversation as resolved.
Show resolved Hide resolved


### Development setup 👩‍💻

1. 🚀 [Set up your local development environment](https://docs.nextcloud.com/server/latest/developer_manual/getting_started/devenv.html)
2. 🐛 [Pick a good first issue](https://github.com/nextcloud/server/labels/good%20first%20issue)
3. 👩‍🔧 Create a branch and make your changes. Remember to sign off your commits using `git commit -sm "Your commit message"`
4. ⬆ Create a [pull request](https://opensource.guide/how-to-contribute/#opening-a-pull-request) and `@mention` the people from the issue to review
5. 👍 Fix things that come up during a review
1. 🚀 [Set up your local development environment.](https://docs.nextcloud.com/server/latest/developer_manual/getting_started/devenv.html)
2. 🐛 [Pick a good first issue.](https://github.com/nextcloud/server/labels/good%20first%20issue)
3. 👩‍🔧 Create a branch and make your changes. Remember to sign off your commits using `git commit -sm "Your commit message"`.
4. ⬆ Create a [pull request](https://opensource.guide/how-to-contribute/#opening-a-pull-request) and `@mention` the people from the issue to review.
5. 👍 Fix things that come up during a review.
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).
Copy link
Contributor

Choose a reason for hiding this comment

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

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

Copy link
Author

Choose a reason for hiding this comment

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

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?

Copy link
Member

Choose a reason for hiding this comment

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

I think that's fine.

Copy link
Member

Choose a reason for hiding this comment

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

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

Copy link
Author

Choose a reason for hiding this comment

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

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?


Several apps that are included by default in regular releases such as [First run wizard](https://github.com/nextcloud/firstrunwizard) or [Activity](https://github.com/nextcloud/activity) are missing in `master` and have to be installed manually by cloning them into the `apps` subfolder.

Otherwise, git checkouts can be handled the same as release archives, by using the `stable*` branches. Note they should never be used on production systems.
Otherwise, git checkouts can be handled the same as release archives, by using the `stable*` branches.

⚠️WARNING⚠️ **they should never be used on production systems.**

### Working with front-end code 🏗

Expand Down