Improve Quick start guide for Developers documentation

[Mishrasubha]

Instant run is missing in Android Studio 3.5 and is replaced with Apply Changes in Run. So, the documentation needs to be updated.

[maskaravivek]

@Mishrasubha Can you provide more details about the issue?

[Mishrasubha]

It is written in Quick start guide for Developers documentation to Disable Instant Run in Android studio by doing the following steps:
In the menu bar, click File > Settings
In Build, Execution, Deployment > Instant Run uncheck the Enable Instant Run checkbox
Click OK to save and exit from the settings window.
But for Android Studio 3.5 this has been removed and replaced with "Apply Changes".

[maskaravivek]

Okay thanks for pointing out the issue. We will fix it.

[maskaravivek]

@misaochan This is another instance where it would have been great if the volunteers would have been able to help us update the documentation. Given the tight control we want for our docs, we can probably consider some workaround for letting volunteers contribute to wiki documentation.

One approach is described here where people maintain a separate fork for the wiki. https://stackoverflow.com/questions/10642928/how-to-pull-request-a-wiki-page-on-github

[misaochan]

@maskaravivek I agree. It's a pity GitHub does not have that option, at the very least they should be able to submit pull requests to it!

I actually wonder if we can/should migrate to MD files instead. That way they can be maintained with pull requests like the rest of the repo. The solutions mentioned in your SO thread would have a higher maintenance overhead IMO, especially if many small changes are made.

[domdomegg]

I've fixed the docs, just removed the bit about Instant Run now the new android gradle plugin fixes the underlying issue (see #3443)

I've been thinking about the wiki, and actually think the best idea would be a mix of the two: have a seperate repo, where we store MD files. I think having it in the main repo doesn't make too much sense (as at the moment changes are quite heavy, as Travis will build an android build for every small change) - plus it means we can be less tight with reviews etc. before merging as it's docs only.

If people are happy with that propsal I'm happy to create it and migrate the existing wiki over (shouldn't be too hard, as under the hood it's already a git repo).

[maskaravivek]

I am happy with this proposal. Let us wait for @misaochan's opinion.

[misaochan]

I'm happy with this as well. We can update our readme.md to point users to the documentation repo, too. :)

Thanks @domdomegg !

[sivaraam]

I'm happy with this as well. We can update our readme.md to point users to the documentation repo, too. :)

Oh, and don't forget to link to it from the then main page of the wiki for better reach!

[domdomegg]

I've moved the wiki to commons-app/documentation - let me know what you think. Always happy to change it with feedback, and the easiest time to do that is now :)

If everyone's happy with how that seems (at least for now) I'll update the links from this repo's README. I'll try to go through and fix the non-big-structural issues later (e.g. some articles lacking titles, inconsistent title sizes, outdated docs)

[misaochan]

Thank you for your work @domdomegg ! The new repo looks great IMO. :)

[sivaraam]

@domdomegg The repo is really good and well organized. I love the way you've used the emojis. It gives it a really nice touch. 🙂 Great job ❣️

Just a few questions:

• I see that the specific docs [1] [2] don't have a header at the top. Is there any reason for this?
• Wouldn't it be nice to organize the pages into folders mirroring the way they are categorized in the wiki page?

I'll be glad to send a PR (which is the whole point of introducing the repo!) that makes the changes related to the suggestions above. Just wanted to get some inputs/opinions before I do that. 🙂

[domdomegg]

• I see that the specific docs [1] [2] don't have a header at the top. Is there any reason for this?

No, just that GitHub doesn't store wiki page's titles in the markdown files you export them as - I'm planning on writing a script to add all the titles soon.

EDIT: done

• Wouldn't it be nice to organize the pages into folders mirroring the way they are categorized in the wiki page?

Yeah that would be good - just make sure to update the links :)

I'll be glad to send a PR (which is the whole point of introducing the repo!)

Feel free to tag me for a review :)

[maskaravivek]

Thanks a lot @domdomegg :)