cozy / cozy-docs Goto Github PK

Seems that the twitter logo asset was missed on last deploy (it's ok when running local docpad run):

In, http://cozy.io/en/hack/cookbooks/understanding-dev-environment.html command is vm:image-update instead of vm:update-image.

The left menu isn't scrollable, so last items are hidden on small screens (especially on french version).

Add some legal stuff.
See http://www.legavox.fr/blog/maitre-anthony-bem/defaut-mentions-legales-sites-internet-16683.htm

As reported by a user. In http://cozy.io/en/host/install/install-on-debian.html, we recommend to use lsb_release -c to get Debian version. But lsb_release is not available on Wheezy, so users of Wheezy get an error.
@nledez or @Kloadut, could you update the documentation ? Thanks !

From forum, we should precise that fab should be installed to reset security token.

Developers often misunderstand how cozy-dev deploy behave. See for example https://github.com/bnjbvr/kresus/issues/155

In src/documents/en/hack/getting-started/architecture-overview.html.md

• tranverse, not an English word, not sure what it should be

In src/documents/en/hack/cookbooks/data-system.html.md

• recuce, should probably be reduce

Some users installing Cozy are not aware that it need Nginx. We should make it clearer in the doc, and also provide sample configuration of Apache vhosts, for user already running a Web server.

cc @franck-paul

I'm currently working on Cozy Notes, and Brunch has generated or edited some files beyond the ones that I'm editing myself. Should I include those files with a pull request? Or should I leave them out?

Thanks.

[This is for "hacking cozy"]

If you run the cozy apps directly from the local system (i.e. not inside a vagrant VM), you can use nodemon to live-reload the code when it changes. I tried it for the file app and the reload happens fast on the local machine.

All you need to do is:

• install nodemon - npm install -g nodemon
• run the app [PORT=something] nodemon server.coffee

I leave it up to you where you think this info belongs, but I really think it should be added to the docs. Maybe also mention the usage of brunch w together with this, in a cookbook like "Live reload of code" (jsilvestre's suggestion on IRC).

@frankrousseau, do you think it would be worth adding to the doc my article on how to port a static Web app to Cozy ?

We need to improve the process for requesting instances. Here are a few changes I would like to see:

At the top of the page:

1 - Insert a "About" link that leads to the About section (may need to add an "about" id there)
2 - Insert a "Contact" link also that takes the visitor to the "Get in touch" section http://cozy.io/fr/#contact

Further down:

3 - Insert a "instance-request" id next to the "I want to contribute form" so that we can send people to http://cozy.io/fr/#instance-request by email
4 - replace "you can also write directly to [email protected] if you prefer" by "Need to contact the team for other reasons ? Just use this trusty and decentralized tool called email by sending a message to [email protected]"

Some path mentioned into the documentation are wrong when installing Cozy using the .deb package. For example, couchdb is located at /var/lib/couchdb and its logs in /var/log/couchdb.

@nledez do you see other paths that differ ?

Digital Ocean 1GB + Debian 7 seems fine.
About OVH VPS, it's still a work in progress.

The documentation should explain in which order the user should start the servers or applications.

For example, I think the home won't start if the data-system is not started itself ?
I believe the order to be data-system > home > proxy ?

From anonymous on IRC:

http://cozy.io/hack/ is on #403 linked by "If you want to know more about our architecture check the full documentation." from the home page

See https://github.com/cozy/cozy-docs/blob/master/src/layouts/homepage.html.jade#L317

As reported by a user, our documentation concerning security (SSL renewal, CouchDB password) are too thin, and we may add some extra infos to drive users through this cases: http://cozy.io/fr/host/install.html#consid-rations-sur-la-s-curit-avec-les-images-pr-install-es.

I'm reading the installation instructions for Ubuntu.

I'm testing on a Ubuntu 14.04.2 virtual machine (running in GNOME Boxes on my Ubuntu 15.04 64-bit desktop).

When I get to this command...

sudo echo 'deb https://ubuntu.cozycloud.cc/debian trusty main' \
 > /etc/apt/sources.list.d/cozy.list

...when I try this, it says "Permission denied." I'm only able to add the source if I manually run sudo vim and paste the string into the cozy.list file, or if I run the echo command after changing to the root user with sudo su.

Does this happen for you too? If this is reproducible, let's correct it. If it only happens for me, though, this permissions issue confuses me.

“You will stay because you can leave” sang a popular crooner. We should better document how to leave Cozy:

• how to backup the database;
• how to migrate its server from one provider to another;
• how to get its data from Cozy in a format allowing to import them to another platform.

Maybe also a “leave Cozy” application ? /cc @Benibur

Some of our applications doesn't compile with old versions of coffeescript (problems have been reported when trying to compile konnectors with coffee 1.4), we should add a warning for people forced to coffeescript to hack one of our applications.
@aenario : what is the minimum version required ?

Right now, the Data System, ODM, and Controller APIs are only described in the "Cookbooks" section of the developer docs. A full API reference, which explains the types and semantics of every method and property, etc., could be useful. And these API references should probably be in their own section of the developer documentation.

What do you think?

In the reset password email, we says “Don't forget to update all your encrypted data afterwards!”. I think most users won't understand what this mean, so we should add an explanation somewhere inside the documentation. (there's already some documentation inside the developer doc. but it's not end user oriented).

Once it has be done, please open a new issue inside cozy/cozy-proxy to add the url of this documentation to the reset password documentation.

At top of the page: https://github.com/cozy

Hi,

There is a broken link in src/documents/fr/host/install.html.md: see "description de l’architecture".
The generated URL is "https://cozy.io/fr/hack/getting-started/architecture-overview.html" but there is no "hack" directory in the "fr" one.

Maybe this link should use the URL "https://cozy.io/en/hack/getting-started/architecture-overview.html" with "(en anglais)".

Users should be informed that they must use git-bash rather than the built-in console, and that they don't have to use sudo.

Here's the draft of this documentation :
https://mensuel.framapad.org/p/cozypostfix

Once the documentation is online, please open a ticket on home screen to link this documentation from parameters screen, on self-hosted instances.

One of our contributors published a nice tutorial on Docker, we should add it to the documentation.

• review: @Kloadut
• translate into french and publish: @LeMelon

I'm reading src/documents/en/hack/getting-started/discover-americano.html.md.

Under the "Define the models" heading (starting at line 79), I see this code snippet:

module.exports =
  bookmark: {
    all: function(doc) {
      emit(doc._id, doc);
    }
  };

This doesn't appear valid. I believe this should have another set of curly brackets wrapped around bookmark, like this.

module.exports = {
  bookmark: {
    all: function(doc) {
      emit(doc._id, doc);
    }
  }
};

Unless you meant something else...?

See this thread.

Update information about cozy-monitor is missing.

When I run the website locally through docpad, the menu is not properly displayed. It doesn't match what is displayed in production.

@aenario and I want to put together a repo with the cozydb schema for our app's doctypes + documentation using literate coffee (http://coffeescript.org/#literate) so it can be added to cozy.io too.

In, http://cozy.io/en/hack/cookbooks/understanding-dev-environment.html, we should precise that vm should be started before update it.

You probably forgot but when you want install Polyglot you need to modify the /client/config.coffee and add:

  plugins:
        jade:
            globals: ['t']

  files: ...

In my case, the tuto dont work and add this have resolve my issue.

This appears to be the case when installed from installed from the fabfile
(https://github.com/cozy/cozy-setup/blob/master/fabfile.py#L585-L586)

But not on the lxc install docs (https://github.com/cozy/cozy-docs/blob/40c66489fb3a07d490c11fa498c0f1ba3bc50d60/src/documents/host/install.html.md#lxc-image)

May be also add a few lines about it somewhere "If you use a reverse-proxy, make sure it supports websockets."

Original issue : cozy/cozy-calendar#99
@bnjbvr, could you tell us which install you used ?

See my comments on 5148edb#commitcomment-8498702

Hi @cosinuz,

I see you made quite a lot of typo & grammar fixes. Thank you very much !

Is it ok with you if we merge those fixes now ?

Here is what @FromBabylon says:

I thought it would be a good idea to create a topic about things that need to be updated/changed in the documention of the cozy.io website.
I bet you can't think about it everyday and that could make your job easier if people reports problems here.

I am not sure whether it's the right place for such a topic but let's start smile

Installation

Create self-signed certificate
-> "Créer un certificat autp-signé" (in the french page)
-> "openssl req -new -x509 -days 3650"
-> "chmod 640 server.key" As most users will run nginx master process as root and the actual certificate key is unencrypted it may be a better idea to chmod 400 ie make it only readable by root (as it has been created by root). Can someone confirm ?

LXC image
I have installed lxc on 2 different OS : ubuntu and archlinux. For both here are my points:
-> "lxc console " should be "lxc-console ".
-> You could maybe provide an https config like the one above ?

Manage your cozy
Be clear on whether user should use sudo or not to manage apps via cozy-monitor :

"To update a single application, you can run the following command on your target server.
sudo cozy-monitor update
"
In the manage section the same command appears without sudo.

That was the little things I saw while browsing smile

Yesterday I wanted to show that we provide a template helper to start coding a Cozy app and I didn't find that command neither in docs and in the cozy-dev README. That should be displayed first.