GithubHelp home page GithubHelp logo

Comments (4)

harry-wood avatar harry-wood commented on August 12, 2024

Oh yeah. Lots of info in CONTRIBUTING.md <!-- all commented out --> I agree that is confusing.

I didn't really understand why @michael63-osm decided to comment out the whole thing. There's certainly some sentences there which are still valid. I'm happy to have a go at doing a less brutal pruning of the info if that helps.

I see in the discussion here he said
"I will add some hints about the structure of the documents in the near future."
but that was early 2020.

from learnosm.

michael63-osm avatar michael63-osm commented on August 12, 2024

Sorry for the confusion, I was not really aware that people pay attention to this file.

The modification to that file was around the time when we started writing a couple of documents for people who want to help:
https://github.com/hotosm/learnosm/blob/gh-pages/_posts/en/0150-09-20-translator_en.md as a guide for how to translate the contents from English and
https://github.com/hotosm/learnosm/blob/gh-pages/_posts/en/0150-06-20-images-translator_en.md as a guide for how to provide localized images.

You will be directed to these pages when you click on the pencil icon at the top right of each page. What is missing is a guide how to contribute new English contents. I would prefer to add that one to the other two documents, wouldn't mind including them all as links in CONTRIBUTING.md but am of course open to other suggestions.

The previous translation workflow outlined in CONTRIBUTING.md is no longer supported since we switched to Transifex.

from learnosm.

harry-wood avatar harry-wood commented on August 12, 2024

Ah yes. There is quite a lot of 'contribute' info elsewhere. Actually a good generic explanation I hadn't noticed is the three paragraphs here: https://github.com/hotosm/learnosm#contributing . Also, as you say, "when you click on the pencil icon" https://learnosm.org/en/contribute/ there's another generic single paragraph on a "contribute" homepage.
Lot of different places. Maybe deleting the CONTRIBUTING.md (to avoid github's auto-linking) file does make the most sense: #652

from learnosm.

matkoniecz avatar matkoniecz commented on August 12, 2024

Maybe deleting the CONTRIBUTING.md (to avoid github's auto-linking) file does make the most sense

I would rather replace its contents by links to a documentation if it exists elsewhere

from learnosm.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.