Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create an AppData file #235

Merged
merged 1 commit into from
Mar 26, 2015
Merged

Conversation

glawrence
Copy link
Contributor

As per issue #178 I have created an AppData file and got it to install
to /usr/local/share/appdata/. I believe the license and updatecontact
tags need checking.

</screenshots>
<url type="homepage">http://sqlitebrowser.org/</url>
<url>https://github.com/sqlitebrowser/sqlitebrowser</url>
<updatecontact>info@sqlitebrowser.org</updatecontact>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmmm, we don't have an email address set up for the @sqlitebrowser.org domain, so that's probably not right.

Can we point at the GitHub Issues page for the contact point, or leave out the email?

Although we could create a working email address via MX record stuff (not hard), I'd rather not for now... it'd be just another target for spammers. 😦

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The spec says file standard updates are sent to the address, so would be good to receive them but like you say, spam is a concern. Maybe we should omit it then? Very happy to re-roll with it removed.

@justinclift
Copy link
Member

Yeah, lets omit it. 😄

@glawrence
Copy link
Contributor Author

E-Mail address now removed, I assume you are happy with the licenses I referenced? I stated "Creative Commons Zero v1.0 Universal" for the appdata.xml file itself which is usually different to the project and one of the four permitted ones and then said the project is licensed under "Mozilla Public License 2.0" and "GNU General Public License v3.0 or later".

@justinclift
Copy link
Member

Excellent. Yep, the licensing info is fine. 😄

Now, lets see if @hughsie can look it over and approve. @hughsie ?

@hughsie
Copy link

hughsie commented Mar 24, 2015

Mostly okay, but a few issues:

appstream-util validate sqlitebrowser.desktop.appdata.xml 
sqlitebrowser.desktop.appdata.xml: FAILED:
• tag-invalid           : <url> type invalid [unknown]
• style-invalid         : <image> has vertical padding [https://github.com/sqlitebrowser/sqlitebrowser/raw/master/images/sqlitebrowser.png]
• style-invalid         : <image> has horizontal padding [https://github.com/sqlitebrowser/sqlitebrowser/raw/master/images/sqlitebrowser.png]
• style-invalid         : <li> is too short [Search records]
Validation of files failed

A url without a type is invalid (perhaps you meant type="bugtracker") and the other issues are just style warnings that would go away using validate-relax. Thanks!

@justinclift
Copy link
Member

@hughsie What's the vertical / horizontal padding warning about?

@hughsie
Copy link

hughsie commented Mar 24, 2015

@justinclift We rely on there being no alpha padding around the screenshot so we can scale it to fit the application area. This means the screenshots have to be taken without any kind of "fuzzy border" -- or you can remedy this in GIMP/Photoshop. Also, the screenshot is supposed to be what it looks like on Linux :) See http://people.freedesktop.org/~hughsient/appdata/#screenshots for more details; thanks.

@justinclift
Copy link
Member

Gotcha. How important is it?

Preferably, I'd strongly like to be able to ignore those two warnings. Bulking out our git repo just to fix these warnings... not really a fan of that idea.

?

@justinclift
Copy link
Member

Hmmmm, if we can have the screenshots in a different repo, that might be the solution. That would avoid bulking out our main source repo.

@hughsie
Copy link

hughsie commented Mar 24, 2015

@justinclift Any screenshot is better than no screenshot, but I'd really like the application installer to look sexy and coherent. If you need space I can host a static image somewhere, although I'd much prefer this was in your control for obvious reasons. If it helps, about half of the apps with AppData have the screenshot in the VCS :)

@justinclift
Copy link
Member

k, I'll create a "screenshots" repo here and we can have them in there. That'll avoid bulking out the repo size for 99.9% of people using the source. 😄

@justinclift
Copy link
Member

k, new repo created here:

    https://github.com/sqlitebrowser/db4s-screenshots

We can add screenshots in there (Pull Requests accepted btw), and then choose a suitable one for the AppData file.

@glawrence
Copy link
Contributor Author

@hughsie I understand what <li> too short means but inclined to ignore that, the text is a direct copy of the website. Is there a list of valid url types, I could not see anything at http://people.freedesktop.org/~hughsient/appdata/ ? I did try using the validator on the web page but it did not work.

@justinclift thanks for the new repo, do you know someone who could trim the existing image or make a new one?

@hughsie
Copy link

hughsie commented Mar 24, 2015

@glawrence You can ignore the two short style warning in this case, it's a little redundant. The URL types are defined here: http://www.freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-url

@glawrence
Copy link
Contributor Author

@hughsie thanks. I was thinking of adding GitHub repo as a second homepage but it is easy to get to from the main website, so will add a link to issues as a bugtracker. I guess once I fix the url we could run with this right? Or should we really fix the image first?

By the way, the xml file lands in /usr/local/share/appdata/ so is that okay?

@hughsie
Copy link

hughsie commented Mar 24, 2015

@glawrence Fixing the screenshot can be done whenever, but I'd obviously prefer it not be forgotten about :) /usr/local/share/appdata/ isn't ideal, but if if you install the .desktop file to /usr/local/share/applications I'm sure the packager is just doing a simple mv to get things in the right place already.

@glawrence
Copy link
Contributor Author

@hughsie thanks, understood, I have updated the xml now

@justinclift happy for you to merge this or wait for an updated screenshot

@justinclift
Copy link
Member

I'll get some updated screenshots into the repo in a few hours. I have some that @MKleusberg @rp- and @piacentini (I think) emailed to me a while ago, which I never got around to committing. If @Samir-Aguiar or anyone else wants to directly commit some or do a PR on the screenshot repo with new ones, that's good too.

@glawrence If the screenshots aren't ready by the end of tonight (unlikely, but could happen), then I'll just merge this change as-is and we can do the screenshot update later. 😄

@glawrence
Copy link
Contributor Author

@justinclift thanks, would be nice to roll this in and then we go see how well it all works. If you let me know when the screenshots are in I will add them to the xml. Ideally we need a default one showing a good overview, like the current one and then we can add more. Just for information:

"Ideally, all screenshots should have a 16:9 aspect ratio, and should have a width that is no smaller than 620px. They should also be in be in PNG or JPEG format. PNG is the preferred format; JPEG should only be used when screenshots include large photographs or other images where a lossy format like JPEG may compress better."

@justinclift
Copy link
Member

@glawrence Did them right away instead. They're for v3.3 (interface is pretty much the same).

Are any of them suitable, with the 16:9 restriction? If so, pick one. Your choice. 😄

@glawrence
Copy link
Contributor Author

Will take a look as soon as I can and update the XML, will be all good after my next commit!

@justinclift
Copy link
Member

@glawrence Cool. Btw, would you be ok to merge the commits into a single one? Makes it better/easier for the repo history that way. 😄

@glawrence
Copy link
Contributor Author

@justinclift everything is ready now, in that I have added the new screenshots. I am happy to merge the commits into a single one but I can't fathom how, I have searched and tried a few things but failed. So, if you want me to merge them then I will need some steps please, sorry!

@justinclift
Copy link
Member

Sure, there are a few ways to do it. This way (below) is the way I generally do it, out of bad habit. 😉 (but it works)

So, first jump into your git repo directory, and do a git log to see what's what:

$ git log
commit c3e5fbda48e06fc7dcfe7284723841c6d8df8e7c
Author: Geoff Lawrence <geoff.j.lawrence@gmail.com>
Date:   Wed Mar 25 21:16:12 2015 +0000

    Updated with new images

    Final change with images from new repository

commit 4bb0dbc3b9d4803b3c3647257a8c331d93ecc768
Author: Geoff Lawrence <geoff.j.lawrence@gmail.com>
Date:   Tue Mar 24 15:05:24 2015 +0000

    Changed url to direct to issues

    Need to specify a url type, so used bugtracker

commit 1d1a019a5b4f783080176bed6d53673d1cb388c2
Author: Geoff Lawrence <geoff.j.lawrence@gmail.com>
Date:   Tue Mar 24 09:09:43 2015 +0000

    Removed e-mail address

    There is no e-mail on the sqlitebrowser.org domain

commit 3ee1ecbb897879109d4a37111a3d579a0dd2ed5d
Author: Geoff Lawrence <geoff.j.lawrence@gmail.com>
Date:   Mon Mar 23 17:12:17 2015 +0000

    Create an AppData file

    As per issue #178 I have created an AppData file and got it to install
    to /usr/local/share/appdata/. I believe the license and updatecontact
    tags need checking.

commit c3c8f8ce568114d7aae1ae263e03390617c7c878
Author: Samir Aguiar <samir.aguiar90@gmail.com>
Date:   Sat Mar 14 22:32:41 2015 +0100

    sqlitetablemodel: Don't apply NULL fields colours to BLOB fields

This shows the commits you've added since Samir's last one. What we want to do is rewind the commit log back to Samirs commit, then add your new files in one brand new commit.

So, using the id for Samir's commit - c3c8f8c - do this:

$ git reset c3c8f8ce568114d7aae1ae263e03390617c7c878
Unstaged changes after reset:
M   CMakeLists.txt
$ git add CMakeLists.txt
$ git commit

It will ask you for the new commit message, and will do a new commit right after Samir's. Do a git log again, to verify it seems sane:

commit 12f266c6ff2a4c4763a26b37f150f4e444948f74
Author: Justin Clift <justin@gluster.org>
Date:   Wed Mar 25 22:19:18 2015 +0000

    A super awesome git commit message! :)

commit c3c8f8ce568114d7aae1ae263e03390617c7c878
Author: Samir Aguiar <samir.aguiar90@gmail.com>
Date:   Sat Mar 14 22:32:41 2015 +0100

    sqlitetablemodel: Don't apply NULL fields colours to BLOB fields

commit 7a6410c04fb4a94e5648b2c4c2dcd2a22ee48c83
Author: Martin Kleusberg <mkleusberg@gmail.com>
Date:   Sat Mar 14 01:32:48 2015 +0100

    When searching for a column by name make the search case insensitive

    See issue #228.

Except it will have your new commit in there instead of my bogus example one. 😄

Then push it back here to GitHub, which should automagically 😉 update this issue with it.

Workable?

@glawrence
Copy link
Contributor Author

Yes, it was fine, once I figure out git push --force was what I needed. Hopefully this is good to go now!

justinclift added a commit that referenced this pull request Mar 26, 2015
@justinclift justinclift merged commit e0d45b7 into sqlitebrowser:master Mar 26, 2015
@justinclift
Copy link
Member

Thanks @glawrence, that's Awesome. 😁

@hughsie
Copy link

hughsie commented Mar 26, 2015

Thanks guys!

@glawrence
Copy link
Contributor Author

You're welcome. So @justinclift I now need to find the next thing I can help with!

Thanks to you and @hughsie appreciate your support

@justinclift
Copy link
Member

The wiki needs helping along, if you're up for it? 😄

@glawrence
Copy link
Contributor Author

I will take a look and see what I can do, thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants