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 CONTRIBUTING.md #327

Merged
merged 1 commit into from
Feb 20, 2015
Merged

Update CONTRIBUTING.md #327

merged 1 commit into from
Feb 20, 2015

Conversation

althio
Copy link
Collaborator

@althio althio commented Feb 19, 2015

add links to conventions and guidelines for contributing

add links to conventions and guidelines for contributing
@Nick-Tallguy
Copy link
Collaborator

@althio - Looks pretty good to me.

Not sure if we should go with the system outlined for the image filing though. I think @pyrog is advocating something slightly different & I'm keen to hear his advice.

At the moment we seem to be part way between:

  1. /images/language (2digit)/section/file/filename
  2. /images/language/section/file/complicated filename to do with filename, language (de_beg_02_start-osm_export.png)
  3. the system outlined here https://github.com/hotosm/learnosm/wiki/Images-guidelines-beta
  4. images/language/filename/simpleimagename such as iD_01.png

1/. I don't like because of the /section/ folder - one of the advantages we are trying to achieve is the ability to quickly create a new 'index' so that a section appears elsewhere. If we have a /section/ folder we defeat that.
2/. Just makes my eyes go blurry trying to find anything - sorry, simple as that!
3/. Blurry eyes, plus we will end up with too many images in one folder for ease of locating.
4/. Just looks simple while avoiding the problems of 1, 2 & 3. My example above would be:
/images/en/remote/iD_01.png

If we're going to alter the image storage system, perhaps now is the time to update the documentation - which is wrong anyway according to what we've got.

The wiki reads as if it was aimed at converting google docs into markdown docs for creating the site. Although interested it may be time to do some drastic altering. Personally when I'm adding images I'm creating them using a variety of steps, avoiding having any writing in them at all (so they can be used in all language versions) and using Gimp to reduce them to 520px - there is discussion in one of the issues about this and I think the consensus I would go for is 'use whatever software you find easiest so you end up with an image of no more than 520px'

If we update the wiki &/or contributing.md now so it shows the system we are aiming for, we will know what to do in the future, and hopefully not have conflicting advice.

@pyrog
Copy link

pyrog commented Feb 20, 2015

In "my" sandbox, I use only one image folder but there will be to many images.
I thought we could use a folder by guide, but I like 4/.

But I prefer to avoid language subfolder and use a language extension (See Content negotiation concept).

/images/remote/iD_01.png for the english version
/images/remote/iD_01.fr.png

If an image is "neutral language" (like a picture of a mapper using a gps receiver) all "translations" use the "english" image (/images/gps/mapper-holding-a-gps-receiver.png)

But if the image contain important text or have a cultural meaning, for example french translation of a chapter use /images/field-papers/website.fr.png if french translators provide it, otherwise they use the "english" version.

See Internationalization and localization of images.

@althio
Copy link
Collaborator Author

althio commented Feb 20, 2015 via email

@Nick-Tallguy
Copy link
Collaborator

@althio sorry I hijacked this, but I think we have a working resolution on a filing system - as per pyrog's suggestion. I've pasted it into #306

Nick-Tallguy added a commit that referenced this pull request Feb 20, 2015
@Nick-Tallguy Nick-Tallguy merged commit 2469fda into gh-pages Feb 20, 2015
@Nick-Tallguy Nick-Tallguy deleted the althio-patch-1 branch February 20, 2015 23:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants