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

Update README.md #19842

Closed
wants to merge 11 commits into from
Closed

Update README.md #19842

wants to merge 11 commits into from

Conversation

aspdye
Copy link

@aspdye aspdye commented Oct 16, 2015

As described in #19792. Not finished yet. Feedback is welcome ;)
It is based on the README.md of "ownCloud Mail".

Thanks to @jancborchardt @Gomez @DeepDiver1975 @enoch85 @ChristophWurst @AndyScherzinger @karlitschek @jakobsack @Xenopathic ;)

My plan is to do use these template (when it is finished) for every README.md of the ownCloud Project (Calendar, Contacts,...).

@LukasReschke
Copy link
Member

Looks already pretty awesome! 🚀
(Preview is at https://github.com/aspdye/core/blob/master/README.md)

aspdye added 3 commits October 16, 2015 17:47
#2
-Added icons to "Get in touch"-Section
-Added "Why is this so awesome?" (I need some more reasons :D)
-Fixed "..."-stuff in the "Why is this so awesome?"-Section
-Fixed problem with the reference code "2" given in the last patch (Because i called it [hashtag]2) 😒😒
@MorrisJobke
Copy link
Contributor

Looks good so far :)

aspdye added 2 commits October 17, 2015 10:53
Added some points to "Why is it so awesome"-section
@enoch85
Copy link
Member

enoch85 commented Oct 17, 2015

Nice!


[![Dependency Status](https://www.versioneye.com/user/projects/54d1f76f3ca0840b190000c0/badge.svg?style=flat)](https://www.versioneye.com/user/projects/54d1f76f3ca0840b190000c0)
## Why is this so awesome?
* :file_folder: **Acess your Data** You can store your files, contacts, calendars and more on a server of your choosing.
Copy link
Contributor

Choose a reason for hiding this comment

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

s/Acess/Access/

@MorrisJobke
Copy link
Contributor

@aspdye Can you - once you are ready - squash everything please? I can help you with this if you want. Just ping me in IRC ;) (my name there is morrisjobke ;))

@aspdye
Copy link
Author

aspdye commented Oct 18, 2015

@MorrisJobke I will contact you this week via IRC ;)

@MorrisJobke MorrisJobke added this to the 9.0-next milestone Oct 19, 2015

[![Dependency Status](https://www.versioneye.com/user/projects/54f4a2384f3108959a000a16/badge.svg?style=flat)](https://www.versioneye.com/user/projects/54f4a2384f3108959a000a16)
![](http://fs5.directupload.net/images/151016/u6zpkz7l.png)
Copy link
Contributor

Choose a reason for hiding this comment

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

Should be hosted on owncloud.org or in the repo?

Copy link
Author

Choose a reason for hiding this comment

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

Of course. Thank you for reporting. Forgotten to change this 😲😲
Does anybody has screenshots of ownCloud Core (Files App with sample content like in Demo) on an official owncloud.org server? @LukasReschke @MorrisJobke

Copy link
Contributor

Choose a reason for hiding this comment

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

Use demo.owncloud.org ;) There is nothing "more official" ;)

Copy link
Author

Choose a reason for hiding this comment

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

@MorrisJobke Yes ;) But where should we host the screenshots?

Copy link
Contributor

Choose a reason for hiding this comment

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

Github? Simply drop then in a comment field here and then copy the URL to the ReadMe ;)

Copy link
Contributor

Choose a reason for hiding this comment

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

They expire

Really? When? Because I have seen multiple projects that are doing it that way 🙈

Copy link
Author

Choose a reason for hiding this comment

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

Just put the images on owncloud.org ;) Then - we would not have expire problems or something ;)

Or we just ask how the guys of the mail's readme.md ( @jancborchardt @Gomez @DeepDiver1975 @enoch85 @ChristophWurst @AndyScherzinger @karlitschek @jakobsack @Xenopathic and me 😁) how they have done that 😉

Copy link
Member

Choose a reason for hiding this comment

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

Put the screenshots on https://github.com/owncloud/screenshots (or take some from there). Just use the raw link, there's no expiration.

Copy link
Member

Choose a reason for hiding this comment

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

cc @jospoortvliet cause he maintains that repo.

@aspdye please don't cc so many people when it's just a question. ;) Someone will quickly help you.

Choose a reason for hiding this comment

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

We can put the screenshots on .org, no problem with that. Note that there are already a bunch of them on .org, find them here:https://github.com/owncloud/owncloud.org/tree/master/assets/img/screenshots/server you can do a PR to that, no problem.

URL's to the images will be a bit odd - looking like this one: https://owncloud.org/wp-content/themes/owncloudorgnew/assets/img/screenshots/server/eight-two/gallery-wee.png

but I'm sure that that is no big deal.

And yes, the other option is to use https://github.com/owncloud/screenshots and use the raw link, there won't be any changes to that as long as github exists ;-) probably easier, too.

@aspdye
Copy link
Author

aspdye commented Nov 29, 2015

So, I have added the screenshot directly from GitHub ;)

Next Step: "Why is it so awesome?" - Section
@MorrisJobke @LukasReschke @enoch85 @jospoortvliet @jancborchardt @PVince81
Could you review my work (on this section) and give some input for the points?

Added "Core" to Headline (ownCloud -> ownCloud Core)
@aspdye
Copy link
Author

aspdye commented Nov 29, 2015

@jancborchardt
Copy link
Member

@aspdye wohooo, this looks great! :) Was just showing the current readme to someone today and noticed again it needs improvement. This is really cool! 👍

Can you squash your commits into one? Then we can review, merge it in, and make any further modifications in future pull requests and improve step by step. Please also review this @jospoortvliet @owncloud/designers

@MorrisJobke
Copy link
Contributor

👍 from my side

@LukasReschke
Copy link
Member

👍

@DeepDiver1975
Copy link
Member

merged in via #20834

@lock lock bot locked as resolved and limited conversation to collaborators Aug 9, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants