User:Althio/Guidelines and Workflow for Images in LearnOSM

From OpenStreetMap Wiki
Jump to navigation Jump to search


This project was originally proposed and is also discussed here: Define Guidelines and Workflow for Images in LearnOSM.

Find more information


How to start

Tackle the following assignments and send your deliverables to [learnosm@hotosm.org] and [mentors-outreachy@hotosm.org].

Assignment #1

Objective

  • Understand the structure and process
  • Assess existing documentation

Work

  • Start from LearnOSM repository at Github.
  • Find where the images are located
  • Find the syntax (more than one) in the text files (Markdown style) to include the images.
  • Find the instructions to add an image.
  • Try to contribute an actual sample (a small image). This is likely to be rather difficult and may require the installation of a Github client.

Deliverables

  1. Deliverable: contact
    • How many ways did you find to contact or exchange with the LearnOSM team?
  2. Deliverable: analysis
    • Provide a diagram showing where the images go and how they get updated.
  3. Deliverable: uploaded image
    • Make a Github pull request to add an image.
    • Report the difficulties you encountered, unclear instructions, missing documentation.


Assignment #2

Objective

Review the current state and gather the ideas.

Work

Read the issues, threads, documents referenced in the notes of the project

Deliverables

  1. Deliverable: analysis
    • For each reference, provide a very short summary to underline the important content, relevant to the scope of the current project
    • Extra: find other references!
  2. Deliverable: synthesis
    • Using your summary from the first deliverable as a starting point, propose your own classification of the outstanding issues, constraints and problems. Choose any criteria you like for instance by topic, priority, requirements.