Add titles in markdown to each file

domdomegg · domdomegg · commit b05f3d810e92 · 2020-03-04T23:40:34.000Z
diff --git a/android/App-functionality.md b/android/App-functionality.md
@@ -1,3 +1,5 @@
+# App functionality
+
 The Wikimedia Commons app offers the following functionality:
 
 ## In-App functionality
diff --git a/android/Category-suggestions-(readme).md b/android/Category-suggestions-(readme).md
@@ -1,3 +1,5 @@
+# Category suggestions (readme)
+
 Three new types of category suggestions were implemented as part of the Outreachy Dec '15 - Mar '16 project:
 
 # 1. If a picture with geolocation is uploaded, nearby category suggestions are offered based on the categories of other Commons images with similar coordinates.
diff --git a/android/Code-Structure.md b/android/Code-Structure.md
@@ -1,3 +1,5 @@
+# Code Structure
+
 ## Key breakdowns:
 
 ### Activities started within the UI:
diff --git a/android/Code-style.md b/android/Code-style.md
@@ -1,3 +1,5 @@
+# Code style
+
 # Commons Android App Style Guide
 
 ## General coding style
diff --git a/android/Code-walkthrough-for-new-devs-(draft).md b/android/Code-walkthrough-for-new-devs-(draft).md
@@ -1,3 +1,5 @@
+# Code walkthrough for new devs (draft)
+
 Note: This is only a draft taken from personal notes, please feel free to improve
 
 ### Share: Incoming Intent
diff --git a/android/Contributing-Guidelines.md b/android/Contributing-Guidelines.md
@@ -1,3 +1,5 @@
+# Contributing Guidelines
+
 Thanks for considering to contribute to this project! A few guidelines for
 people who want to contribute their code to this software are documented
 here. If you're not sure where to start head on to [this wiki page](https://github.com/commons-app/apps-android-commons/wiki/Volunteers-welcome!).
diff --git a/android/Dependency-Injection.md b/android/Dependency-Injection.md
@@ -1,3 +1,5 @@
+# Dependency Injection
+
 ## Overview
 
 At its core, dependency injection is just the principle of `"tell, dont ask"` put into practice; for instance, if a class needs to use an instance of `MediaWikiApi`, it should be handed an instance of the classs rather than reaching out to get it.  This has the effect of decoupling code, making it easier to test and reuse.
diff --git a/android/Developer-workflow.md b/android/Developer-workflow.md
@@ -1,3 +1,5 @@
+# Developer workflow
+
 ## Working on a change
 
 1. Ensure nobody else is already working on the issue. You should read the comments on the issue and read through the open pull requests.
diff --git a/android/External-APIs.md b/android/External-APIs.md
@@ -1,3 +1,5 @@
+# External APIs
+
 The Wikimedia Commons Android app uses several external APIs to do its job.
 
 ## List of APIs used
diff --git a/android/Frequently-Asked-Questions.md b/android/Frequently-Asked-Questions.md
@@ -1,3 +1,5 @@
+# Frequently Asked Questions
+
 1. [Questions about the project](#questions-about-the-project)
 2. [Copyright questions](#copyright-questions)
 3. [Technical questions](#technical-questions)
diff --git a/android/Fuzzy-category-search.md b/android/Fuzzy-category-search.md
@@ -1,3 +1,5 @@
+# Fuzzy category search
+
 # Test data
 
 ## Sample generation methodology
diff --git a/android/GSoC-2018-&-Outreachy-16.md b/android/GSoC-2018-&-Outreachy-16.md
@@ -1,3 +1,5 @@
+# GSoC 2018  Outreachy 16
+
 Huge thanks to all students who have sent us proposals for [Google Summer of Code](https://summerofcode.withgoogle.com/) 2018 and Outreachy 16!
 
 In alphabetical order:
diff --git a/android/GSoC-2019-and-Outreachy-18.md b/android/GSoC-2019-and-Outreachy-18.md
@@ -1,3 +1,5 @@
+# GSoC 2019 and Outreachy 18
+
 Huge thanks to all students who have sent us proposals for [Google Summer of Code](https://summerofcode.withgoogle.com/) 2019 and Outreachy 18!
 
 In alphabetical order:
diff --git a/android/Getting-app-logs-from-Android-Studio.md b/android/Getting-app-logs-from-Android-Studio.md
@@ -1,3 +1,5 @@
+# Getting app logs from Android Studio
+
 Brief walkthrough for users on how to post logs if they are encountering issues.
 
 1. On your computer, [download](https://developer.android.com/studio/) and [install](https://developer.android.com/studio/install) Android Studio
diff --git a/android/Google-Code-in.md b/android/Google-Code-in.md
@@ -1,3 +1,5 @@
+# Google Code in
+
 # Template
 
 Title: `Take screenshots of Commons Android app in your native language`
diff --git a/android/Google-Play-store-listing.md b/android/Google-Play-store-listing.md
@@ -1,3 +1,5 @@
+# Google Play store listing
+
 ## New Listing (2017):
 
 [I am drawing heavily on our website for this, thanks Tobias!]
diff --git a/android/How-to-install-and-use-the-app.md b/android/How-to-install-and-use-the-app.md
@@ -1,3 +1,5 @@
+# How to install and use the app
+
 1. Download **Wikimedia Commons** from the [Google Play Store](https://play.google.com/store/apps/details?id=fr.free.nrw.commons)
 2. Take a picture of something interesting (see: [What files are OK to upload](https://commons.wikimedia.org/wiki/Commons:Project_scope#Scope_part_1:_Files))
 3. In your camera app, click to view the picture you just took
diff --git a/android/June-2018-incident.md b/android/June-2018-incident.md
@@ -1,3 +1,5 @@
+# June 2018 incident
+
 # June 2018 incident - upload-time geotagging
 
 **Summary:** A label in the app's preferences misrepresented a feature of the app that retrieves and publishes location information when uploading a picture. The label said _"Automatically get current location - Retrieve current location to offer category suggestions if image is not geotagged"_, while the app additionally published the current location of the device as part of the file page it creates. Remedies are being done, including a more appropriate label for the feature, redaction of already published location information, and messages to affected users.
diff --git a/android/Languages.md b/android/Languages.md
@@ -1,3 +1,5 @@
+# Languages
+
 The Commons app is localized (sometimes partially) to these languages:
 
 * Abkhazian
diff --git a/android/Libraries-used.md b/android/Libraries-used.md
@@ -1,3 +1,5 @@
+# Libraries used
+
 * [Quadtree][1]
 * [ViewPagerIndicator][2]
 * [Java-HTTP-Fluent][3]
diff --git a/android/Location-based-category-search.md b/android/Location-based-category-search.md
@@ -1,3 +1,5 @@
+# Location based category search
+
 Task: Identify the best strategy/APIs to find Commons categories that are within a certain radius of specified GPS coordinates.
 
 This page will be used to document the results of testing the categories obtained via different APIs/strategies against the benchmark of categories that have been manually entered (by the Commons community or by myself) for each picture. 
diff --git a/android/On-Device-Storage.md b/android/On-Device-Storage.md
@@ -1,3 +1,5 @@
+# On Device Storage
+
 Account credentials are encapsulated in an account provider. Currently only one Wikimedia Commons account is supported at a time. (Question: what is the actual storage for credentials?)
 
 Preferences are stored in Android's SharedPreferences.
diff --git a/android/Passing-an-image-to-the-app.md b/android/Passing-an-image-to-the-app.md
@@ -1,3 +1,5 @@
+# Passing an image to the app
+
 Developers who wish to pass an image from their app to the Wikimedia Commons app can do so using an Intent, just like you would with any other app.
 
 ```java
diff --git a/android/Press-release-[Draft].md b/android/Press-release-[Draft].md
@@ -1,3 +1,5 @@
+# Press release [Draft]
+
 As suggested at [#420](https://github.com/commons-app/apps-android-commons/issues/420), we will be working on drafts for press releases here.
 
 # Press release for third party blogs/sites
diff --git a/android/Privacy-policy.md b/android/Privacy-policy.md
@@ -1,3 +1,5 @@
+# Privacy policy
+
 # Privacy Policy
 
 The Wikimedia Commons Android app is a free, open-source app developed by grantees and volunteers of the Wikimedia community to allow users to upload content to Wikimedia Commons. This APPLICATION is provided by members of the Wikimedia community and is intended for use as is. 
diff --git a/android/Project-maintenance.md b/android/Project-maintenance.md
@@ -1,3 +1,5 @@
+# Project maintenance
+
 # Pull requests and merging workflow
 
 See [Developer workflow](Developer-workflow.md)
diff --git a/android/Quick-start-guide-for-Developers.md b/android/Quick-start-guide-for-Developers.md
@@ -1,3 +1,5 @@
+# Quick start guide for Developers
+
 1. [Download and Install Android Studio][1]
 
 2. Fork the Git repository.
diff --git a/android/Screen-structure.md b/android/Screen-structure.md
@@ -1,3 +1,5 @@
+# Screen structure
+
 The Wikimedia Commons app consists of the following screens:
 
 - Tutorial (4 slides)
diff --git a/android/Setting-up-dev-enviroment.md b/android/Setting-up-dev-enviroment.md
@@ -1,3 +1,5 @@
+# Setting up dev enviroment
+
 Fork the commons repo from github. Now clone this repo to your local machine. Enter the following in terminal (Gitbash for windows users)
 
 ```
diff --git a/android/Software-design-document.md b/android/Software-design-document.md
@@ -1,3 +1,5 @@
+# Software design document
+
 [WIP]
 
 [![Architecture](https://upload.wikimedia.org/wikipedia/commons/thumb/0/0c/Commons_Mobile_App_architecture.svg/1000px-Commons_Mobile_App_architecture.svg.png)](https://commons.wikimedia.org/wiki/File:Commons_Mobile_App_architecture.svg)
diff --git a/android/Students.md b/android/Students.md
@@ -1,3 +1,5 @@
+# Students
+
 # What
 
 TODO
diff --git a/android/Technical-Overview.md b/android/Technical-Overview.md
@@ -1,3 +1,5 @@
+# Technical Overview
+
 The general user facing functionality of the app is already documented (see [App Functionality](App-functionality.md)), this document should try to connect that to the actual code in the repo: What code is there and does what?
 
 ## [/app/src/main/java/fr/free/nrw/commons](https://github.com/commons-app/apps-android-commons/tree/master/app/src/main/java/fr/free/nrw/commons)
diff --git a/android/Translating-the-app.md b/android/Translating-the-app.md
@@ -1,3 +1,5 @@
+# Translating the app
+
 Thanks to the translation work of many volunteers this app is available in a multitude of languages.
 
 Translation of the text content of the Wikimedia Commons Android app happens on the [Commons Android App project](https://translatewiki.net/w/i.php?title=Special:Translate&group=commons-android) on [translatewiki.net](https://translatewiki.net). 
diff --git a/android/Tutorial-for-new-users.md b/android/Tutorial-for-new-users.md
@@ -1,3 +1,5 @@
+# Tutorial for new users
+
 ## New tutorial
 
 Tutorial and app released under Apache 2.0 license. 
diff --git a/android/Volunteers-welcome!.md b/android/Volunteers-welcome!.md
@@ -1,3 +1,5 @@
+# Volunteers welcome!
+
 We are always looking for volunteers, feel free to step in! It's very easy to get started - have a look at the roles that you fancy below. Thanks a lot!
 
 # Developers
diff --git a/documentationtools/titles.sh b/documentationtools/titles.sh
@@ -0,0 +1,8 @@
+# This script adds a H1 header to each .md file, based off that file's name
+# Intended to be used on an export of a GitHub style wiki
+for f in *.md
+do
+	title=$(echo $f | sed s/.md//g | sed s/-/\ /g)
+	echo "Adding title '$title' to $f"
+	sed -i "1s;^;# $title\n\n;" $f
+done

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# App functionality`
	`2`	`+`
`1`	`3`	`The Wikimedia Commons app offers the following functionality:`
`2`	`4`
`3`	`5`	`## In-App functionality`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# Category suggestions (readme)`
	`2`	`+`
`1`	`3`	`Three new types of category suggestions were implemented as part of the Outreachy Dec '15 - Mar '16 project:`
`2`	`4`
`3`	`5`	`# 1. If a picture with geolocation is uploaded, nearby category suggestions are offered based on the categories of other Commons images with similar coordinates.`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# Code Structure`
	`2`	`+`
`1`	`3`	`## Key breakdowns:`
`2`	`4`
`3`	`5`	`### Activities started within the UI:`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# Code style`
	`2`	`+`
`1`	`3`	`# Commons Android App Style Guide`
`2`	`4`
`3`	`5`	`## General coding style`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# Code walkthrough for new devs (draft)`
	`2`	`+`
`1`	`3`	`Note: This is only a draft taken from personal notes, please feel free to improve`
`2`	`4`
`3`	`5`	`### Share: Incoming Intent`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# Contributing Guidelines`
	`2`	`+`
`1`	`3`	`Thanks for considering to contribute to this project! A few guidelines for`
`2`	`4`	`people who want to contribute their code to this software are documented`
`3`	`5`	`here. If you're not sure where to start head on to [this wiki page](https://github.com/commons-app/apps-android-commons/wiki/Volunteers-welcome!).`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# Dependency Injection`
	`2`	`+`
`1`	`3`	`## Overview`
`2`	`4`
`3`	`5`	At its core, dependency injection is just the principle of `"tell, dont ask"` put into practice; for instance, if a class needs to use an instance of `MediaWikiApi`, it should be handed an instance of the classs rather than reaching out to get it. This has the effect of decoupling code, making it easier to test and reuse.
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# Developer workflow`
	`2`	`+`
`1`	`3`	`## Working on a change`
`2`	`4`
`3`	`5`	`1. Ensure nobody else is already working on the issue. You should read the comments on the issue and read through the open pull requests.`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# External APIs`
	`2`	`+`
`1`	`3`	`The Wikimedia Commons Android app uses several external APIs to do its job.`
`2`	`4`
`3`	`5`	`## List of APIs used`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# Frequently Asked Questions`
	`2`	`+`
`1`	`3`	`1. [Questions about the project](#questions-about-the-project)`
`2`	`4`	`2. [Copyright questions](#copyright-questions)`
`3`	`5`	`3. [Technical questions](#technical-questions)`