After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 775215 - Update Wiki page and README to markdown
Update Wiki page and README to markdown
Status: RESOLVED FIXED
Product: geary
Classification: Other
Component: documentation
master
Other Linux
: Normal normal
: ---
Assigned To: Geary Maintainers
Geary Maintainers
Depends on: 770860
Blocks:
 
 
Reported: 2016-11-28 09:54 UTC by Gautier Pelloux-Prayer
Modified: 2017-12-08 00:06 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Gautier Pelloux-Prayer 2016-11-28 09:54:19 UTC
It would be great to update Geary wiki page (https://wiki.gnome.org/Apps/Geary) to use latest apps template such as Web or Polari do (https://wiki.gnome.org/Apps/Web or https://wiki.gnome.org/Apps/Polari).

Quoting Mike, here is some hints about what to do:

> - Show off the new GTK+ conversation widgets
- Use the default GNOME 3.22 theme and background
- Show one GMail and one custom IMAP account
- Make sure any conversations shown have at least one or two non-default avatars
- Have one overall screenshot, showing the two accounts and some folders, the conversation list and a multi-message conversation with both collapsed and un-collpased messages. Maybe also with an in-line reply being composed, if the screenshot doens't get too big. Kind of like Epiphy's[0].
- Have another showing the composer with some rich text and an image being edited
- If there's not enough room to show an inline-composer without making the screenshot way too large, then a third screenshot with a conversation and an inline composer.

In the mean time, it would be a good time to upgrade the README to markdown syntax (See https://github.com/bagage/geary/tree/readme-markdown for a first try) and add one screenshot too (As https://github.com/gnunn1/terminix/ for instance).
Comment 1 Niels De Graef 2016-11-28 13:58:30 UTC
Great idea. Has this idea as well some time ago (https://github.com/nielsdg/Geary/tree/markdown), but this seems a more comprehensive bug :)

Anyway, I think this should reflect in our appdata.xml.in as well (see bug 770860), since it reflects how Geary is displayed in GNOME software.
Comment 2 freeroot 2016-12-10 21:18:38 UTC
Hello,

since Geary is not a part of GNOME release, the Geary development page (https://wiki.gnome.org/Apps/Geary/Development) should displayed tips without the use of jhbuild.

If I understand well, because it's only temporaly, maybe just add a few line to explain the temporaly issue too.

More info in https://bugzilla.gnome.org/show_bug.cgi?id=775933
Comment 3 Michael Gratton 2016-12-12 14:38:55 UTC
(In reply to freeroot from comment #2)
> since Geary is not a part of GNOME release, the Geary development page
> (https://wiki.gnome.org/Apps/Geary/Development) should displayed tips
> without the use of jhbuild.
> 
> If I understand well, because it's only temporaly, maybe just add a few line
> to explain the temporaly issue too.
> 
> More info in https://bugzilla.gnome.org/show_bug.cgi?id=775933

We do occasionally get people trying to build using JHBuild, but since I don't think it is actually mentioned anywhere on the wiki as a valid thing to try, I'm a bit surprised that people do try it. :) I guess JHBuild is pretty common for GNOME though, so I have added a note as suggested to that page.
Comment 4 freeroot 2016-12-12 19:15:09 UTC
Thanks
Comment 5 Michael Gratton 2017-09-25 15:02:24 UTC
Niels, thanks for updating the wiki style, it looks great!

There are now two screenshots attached to it that are referenced from the appdata file in master. These might be useful for cutting up as part of a visual feature tour (as per Ephy's and Polari's pages), but they might need some more work.

I'm thinking maybe the Features section would be a good basis for that, and for the remaining sections, maybe just ditching News, leaving Quick Links as-is, and making Documentation/Getting in Touch/Contribute to Geary all top-level pages, linked to under the banner under the top? Thoughts?

I took the liberty of revamping the README with copy from the web site, and providing a GitHub specific MD version as well (commit a0fc163). Again, feedback on this is welcome.
Comment 6 Michael Gratton 2017-12-08 00:06:16 UTC
The image referenced in README.md could probably be better, but at least it's there now. Closing this as fixed.