Git Product home page Git Product logo

flatpak.github.io's Introduction

Flatpak.org website

Installation and setup

To set up middleman locally on Fedora:

dnf install ruby rubygems rubygem-bundler rubygem-json

In the git checkout, do a bundle install. This installs all the needed modules in their appropriate versions.

Add the middleman binary location (probably ~/bin) to $PATH.

Testing

To run a local web server to test the site:

bundle exec middleman server

Edit the haml/scss files and commit your changes, pushing to origin/source.

Devcontainer

You can also use the devcontainer, for e.g. with VSCode. It should setup automatically and just expects you to run the testing command from above or command you would like to run.

Deployment

Pushing new commits automatically causes to trigger new build and deployment on OpenShift. It usually takes few minutes for changes to become visible. Files used for build can be found in oscp directory.

flatpak.github.io's People

Contributors

alexlarsson avatar allanday avatar asciiwolf avatar barthalion avatar cassidyjames avatar conan-kudo avatar csoriano1618 avatar das-g avatar dependabot[bot] avatar haggen88 avatar jimmac avatar jurf avatar kbdharun avatar matthiasclasen avatar mvaello avatar mwleeds avatar nedrichards avatar palasso avatar phw avatar prcutler avatar razzeee avatar ryanlerch avatar smcv avatar sulincix avatar theevilskeleton avatar tingping avatar travier avatar wjt avatar xarbit avatar zaryob avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

flatpak.github.io's Issues

Allow installing apps using .flatpak or .flatpakref files

Downloading a .flatpak or .flatpakref allows installing an app without having to use the commandline, at least on recent Fedora. The apps page should allow installing apps using this method, since it is the best UX. However, this will require that:

  1. The apps provide those files.
  2. The page includes guidance on which distros and versions support installing in this way; maybe the page will also need a way for the user to say which distro & version they are on, and then show appropriate installation methods depending on that.

Need some text about docker

Talking about flatpak at Flock the immediate question seemed to be "why not just use docker" -- it might be good to answer this question with some statements explaining how desktop apps are different and why ostree is a good choice etc.

Inaccuracies in developer page diagram

I love the idea of visually communicating the way Flatpak works and the current graphic looks great. There are a few issues I see with it though:

  • Runtimes are available inside the sandbox, but they are portrayed as being outside.
  • The animated lines represent very different things - the build process, calling a library at runtime, and IPC between app and operating system. However, they look equivalent, and to my eyes all look like IPC.
  • The graphic doesn't represent the way that runtimes depend on operating systems, and apps depend on runtimes.
  • It would be nice if the graphic could communicate that runtimes (and SDKs) contain libraries.
  • The operating system block uses a GNOME logo; this might be confusing to a lot of people.

How some of these issues could be addressed:

flatpak-diagram

mention systemd --user and cgroups

The technologies section should perhaps mention systemd --user and cgroups.

We may also want to add a list of dependencies / prerequisites somewhere.

"Hello World" tutorial is outdated

On the "Build" section of the webpage, the example tutorial works fine until the user is instructed to run "flatpak build-export repo hello". The user then sees the output "error: Build directory hello not initialized". I believe that the user isn't supposed to get this error message.

Page in question: http://flatpak.org/#developers
log.txt

mention mageia flatpak support

Son_Goku> alexlarsson, so JFYI, Mageia now has Flatpak in Cauldron as of this morning
it'll be part of the Mageia 6 release
7โˆถ56 PM
it can be installed the same way it is on Fedora
as root, running "dnf install flatpak"
or, if using urpmi (the current default package manager), running "urpmi flatpak"

stumbled a bit in the tutorial

I had some issues getting through the tutorial, since I misnamed the file that should be called "metadata" to hello instead.
It might have been because under step 3, every other filename and folder in the tutorial that needs creation has a highlight, while the word metadata only has the "-charachters around it.

Add a carousel with quotes from supporters

I've seen that newstructure2017 branch has a nice list of logos of distros where flatpak will be available. In the commits I've seen some changes about if they where also supported or just available.

In addition to the actual list of logos, maybe a good way to show the supporters of flatpak could be a carousel with some nice quotes. Somethink like this Responsive Quote Carouse

Recently Ikey Doherty from Solus talked very nicely about Flatpak in Linux Unplugged. He also announced that they are adopting flatpak as their solution for distributing 3rd party apps

His quotes and some from Endless and others could fit well. If you like the idea I can try to create a partial or something to add it to the homepage.

Add documentation on portals

It's completely missing from the developer page, probably because they hadn't been implemented when it was written. Things the docs need to say here:

  • High-level description of what portals are and how they work from the point of view of the user.
  • Portals are typically accessed through a UI toolkit. Mention that GTK+ 3.22 will have portals support.
  • If you are a toolkit developer or are writing a completely custom application, documentation is available: http://flatpak.org/xdg-desktop-portal/portal-docs.html

Missing favicon

The link to the favicon is broken because the item does not exisits. This can be autogenerated in the build process with the middleman-favicon-maker gem or manually, of course.

Improve metas for SEO

In order to get a well maintained metadata for SEO, I recommend to use the gem 'middleman-meta-tags' [1]. Is quite easy to use, just have to write key:value tags in the site.yml file and the helper does the hard work for you.

Of course, I can craft a patch for that as well, but first I need to know some extra info ;-)

[1] https://github.com/tiste/middleman-meta-tags

Semi-transparent topbar covers headings

This seems to work for most of the anchors on flatpak.org, but the svg under "How it works" links to the Library/Sandbox sections right below it and clicking on such a link will scroll to it correctly, but now the semi-transparent topbar the heading as well as the first line of the paragraph so one has to immediately scoll up again.

Improve spacing for code sections

While the spacing is good before a code section begins, it's very short after a code section ends. The end result is not that nice and in parts of the documentation it's a bit confusing.

screenshot_20160522_112452

It would be nice if the spacing after a code section ends were increased to at least match the spacing before a code section begins and maybe be 50% more.

Alternatively it might be better to reduce a little the spacing before a code section begins and increase the spacing after a code section ends to what the spacing is now for before a code section begins.

Footer structure is a bit misleading

Some of the headings link to sections on the home page - this is a bit confusing because it looks like the links below them are sub-pages within each section.

Also, some of the headings aren't quite right: "BUILD" and "RUN" don't seem to work as well here, it isn't clear that "Getting Started with Flatpak" is an app building tutorial, and "Downloading Flatpak" is inconsistent with the page it links to ("Getting Flatpak").

It might be better to do something like this:

HOME
About
Run
Build
Get Involved

APPLICATION BUILDING
Building a Java Application with Flatpak

GETTING FLATPAK
Runtimes

FAQ

Nav bar: change "users" and "developers" to "run" and "build"

andreasn   it still says "Users" and "Developers" in the top navigation, 
           even though it has better titles in the page
           "Running" and "Create an app" ?
           "How to run" maybe
aday_      or "install an app" and "build an app" ?
           or even just "run" and "build" ?
           short is good here
andreasn   yeah
           Run and Build are nice

No instructions for how to distribute multiple versions of an app

One of the great things about Flatpak is that you can distribute development versions of an app, as nightlies or something similar. The problem is that, if you give different versions of the app the same dbus name, they end up conflicting with each other [1].

It would be great to include guidelines for how to produce different versions. These would basically say:

  • Rename the app in the .desktop file, such as adding "(Nightly)"
  • Rename the dbus name, such as from "org.domain.app-name" to "org.domain.app-name-nightly"

[1] For details on how Software plans to deal with this issue, see https://bugzilla.gnome.org/show_bug.cgi?id=768729

"Fork me on GitHub" ribbon?

Since most of the development workflow is going to happen on github maybe it'd be nice to put a "Fork me on GitHub" ribbon.

While the "Get Involved" section is good, the ribbon is small, catchy and gets the message out that flatpak is FLOSS, has a github repo and uses github issues and that third-party contributors are welcome to improve it primarily using the github infrastructure.

Some websites that have ribbons:
https://github.com/blog/273-github-ribbons
https://simonwhitaker.github.io/github-fork-ribbon-css/
http://blog.dfilimonov.com/github-ribbons-css/
https://codepo8.github.io/css-fork-on-github-ribbon/

FAQ: Explain "Note that bundles have some drawbacks, compared to a repository."

In reply to the question "Can I host my flatpak app on github?" we end the answer on a limb:

"Flatpak repositories can't (currently) be put on github in a convenient way. As an alternative, you can create a single-file bundle, and put that up on github as a 'release'. Note that bundles have some drawbacks, compared to a repository."

I think it is a good opportunity to provide a convenient link here to some documentation which explains the concepts ("flatpak repositories", "single-file bundles") and elaborate further on the drawbacks of bundles compared to a repository.

Suggested content

Here are some questions that I think might be good to answer, either on the website itself, or as an faq:

  • Can flatpak be used for servers too ?
  • How does flatpak compare to other application sandboxing technologies: zeroinstall, glick, snap, ... ?
  • How does flatpak compare to other packaging technologies: rpm, dep,... ?
  • Which runtime should I use for my app ?
  • What about security updates ?

It's not clear where to report website issues

Although the Get Involved looks like it should be enough, I would make more clear where to report issues and errors. Also make more clear where to do those for the website and for flatpak itself separately.

Document how best to manage a repository

There doesn't seem to be a good document on repository best practices (some of which may require the ostree command, some of which is up to flatpak). Stuff like: versioning (tagging versions you want to keep forever, vs. ones to delete), moving versions between branches, things like that. Basically how I'd approach FlatPak repo management, from a reprepro background.

Add info about how to debug flatpak applications

I'm currently experiencing that one of my installed flatpaks aren't running. it would be nice if the website had a section inside "Build" for "Debugging flatpaks". Stuff like how to get a shell into the sandbox, how to check what permissions the flatpak has, how to find out what dependencies are available in the runtime etc.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.