More cleanup and markup fixes

Author: stickster

deployment/desktop/desktop-software-hosting.md

@@ -8,7 +8,7 @@ order: 3
 
 ## Setting up hosting infrastructure for your package
 
-We will here explain how you set up a Yum repository for RPM packages that provides the needed metadata. If you are making a Flatpak we recommend skipping ahead to the Flatpak section a bit further down.
+We will here explain how you set up a Yum repository for RPM packages that provides the needed metadata. If you are making a Flatpak we recommend skipping ahead to the [Flatpak section](how-to-setup-and-host-flatpaks.html).
 
 ### Yum hosting and metadata
 
@@ -18,7 +18,7 @@ When GNOME Software checks for updates it downloads various metadata files from
 
 When GNOME Software checks for updates it downloads various metadata files from the server describing the packages available in the repository. GNOME Software can also download AppStream metadata at the same time, allowing add-on repositories to include applications that are visible in the the software center.
 
-In most cases distributors are already building binary RPMS and then building metadata as an additional step by running something like this to generate the repomd files on a directory of packages. The tool for creating the repository metadata is called createrepo_c and is part of the package createrepo_c in Fedora. You can install it by running the command:
+In most cases distributors are already building binary RPMS and then building metadata as an additional step by running something like this to generate the repomd files on a directory of packages. The tool for creating the repository metadata is called *createrepo_c* and is part of the package *createrepo_c* in Fedora. You can install it by running the command:
 
 	dnf install createrepo_c
 
@@ -27,27 +27,25 @@ Once the tool is installed you can run these commands to generate your metadata:
 	$ createrepo_c --no-database --simple-md-filenames SRPMS/
 	$ createrepo_c --no-database --simple-md-filenames x86_64/
 
-This creates the primary and filelist metadata required for updating on the command line. Next to build the metadata required for the software center we we need to actually generate the AppStream XML. The tool you need for this is called appstream-builder. This works by decompressing .rpm files and merging together the .desktop file, the .appdata.xml file and preprocessing icons and screenshots. Remember, only applications installing AppData files will be included in the metadata.
+This creates the primary and filelist metadata required for updating on the command line. Next to build the metadata required for the software center we we need to actually generate the AppStream XML. The tool you need for this is called *appstream-builder*. This works by decompressing *.rpm* files and merging together the *.desktop* file, the *.appdata.xml* file and preprocessing icons and screenshots. Remember, only applications installing AppData files will be included in the metadata.
 
 You can install appstream-builder in Fedora Workstation by using this command:
 
-This creates the primary and filelist metadata required for updating on the command line. Next to build the metadata required for the software center we we need to actually generate the AppStream XML. The tool you need for this is called appstream-builder. This works by decompressing .rpm files and merging together the .desktop file, the .appdata.xml file and preprocessing the icons. Remember, only applications installing AppData files will be included in the metadata.
-You can install appstream builder in Fedora Workstation by using this command:
-
 	dnf install libappstream-glib-builder
 
 Once it is installed you can run it by using the following syntax:
 
 	$ appstream-builder				\
 		--origin=yourcompanyname		\
-		--basename=appstream		\
-		--cache-dir=/tmp/asb-cache	\
+		--basename=appstream			\
+		--cache-dir=/tmp/asb-cache		\
 		--enable-hidpi				\
-		--max-threads=1			\
+		--max-threads=1				\
 		--min-icon-size=32			\
 		--output-dir=/tmp/asb-md		\
-		--packages-dir=x86_64/		\
+		--packages-dir=x86_64/			\
 		--temp-dir=/tmp/asb-icons
+
 This takes a few minutes and generates some files to the output directory.  Your output should look something like this:
 
 	Scanning packages...
@@ -59,18 +57,18 @@ This takes a few minutes and generates some files to the output directory.  Your
 	Done!
 
 
-The actual build output will depend on your compose server configuration. At this point you can also verify the application is visible in the yourcompanyname.xml.gz file.
+The actual build output will depend on your compose server configuration. At this point you can also verify the application is visible in the *yourcompanyname.xml.gz* file.
 
-We then have to take the generated XML and the tarball of icons and add it to the repomd.xml master document so that GNOME Software automatically downloads the content for searching. This is as simple as doing:
+We then have to take the generated XML and the tarball of icons and add it to the *repomd.xml* master document so that GNOME Software automatically downloads the content for searching. This is as simple as doing:
 
 	modifyrepo_c					\
 		--no-compress				\
-		--simple-md-filenames		\
-		/tmp/asb-md/appstream.xml.gz	\
+		--simple-md-filenames			\
+		/tmp/asb-md/appstream.xml.gz		\
 		x86_64/repodata/
 	modifyrepo_c					\
 		--no-compress				\
-		--simple-md-filenames		\
+		--simple-md-filenames			\
 		/tmp/asb-md/appstream-icons.tar.gz	\
 		x86_64/repodata/
 		

deployment/desktop/how-to-host-yum-repo-on-github.md

@@ -17,11 +17,11 @@ Github isn't really set up for hosting Yum repositories, but here is a method th
 	git remote add origin [email protected]:yourgitaccount/myrepo.git
 	git push -u origin master
 
-Once everything is imported, go into the Github web interface and drill down in the file tree until you find the file called 'repomd.xml' and click on it. You should now see a button in the Github interface called 'Raw'. Once you click that you get the raw version of the XML file and in the URL bar of your browser you should see a URL looking something like this:
+Once everything is imported, go into the Github web interface and drill down in the file tree until you find the file called *repomd.xml* and click on it. You should now see a button in the Github interface called *Raw*. Once you click that you get the raw version of the XML file and in the URL bar of your browser you should see a URL looking something like this:
 
 	https://raw.githubusercontent.com/cschalle/hubyum/master/noarch/repodata/repomd.xml
 
-Copy that URL as you will need the information from it to create your '.repo' file which is what distributions and users want in order to reach you new repository. To create your .repo file copy this example and edit it to match your data:
+Copy that URL as you will need the information from it to create your *.repo* file which is what distributions and users want in order to reach you new repository. To create your *.repo* file copy this example and edit it to match your data:
 
 	[remarkable]
 	name=Remarkable Markdown editor software and updates
@@ -30,8 +30,8 @@ Copy that URL as you will need the information from it to create your '.repo' fi
 	enabled=1
 	enabled_metadata=1
 
-So on top is your Repo shortname inside the brackets, then a name field with a more extensive name. For the baseurl paste the URL you copied earlier and remove the last bits until you are left with either the 'norach' directory or your platform directory for instance x86_64.
+So on top is your Repo shortname inside the brackets, then a name field with a more extensive name. For the baseurl paste the URL you copied earlier and remove the last bits until you are left with either the *noarch* directory or your platform directory, for instance *x86_64*.
 
-Once you have that file completed put it into /etc/yum.repos.d on your computer and load up GNOME Software. Click on the 'Updates' button in GNOME Software and then on the refresh button in the top left corner to ensure your database is up to date. If everything works as expected you should then be able to do a search in GNOME software and find your new application showing up.
+Once you have that file completed put it into */etc/yum.repos.d* on your computer and load up GNOME Software. Click on the *Updates* button in GNOME Software and then on the refresh button in the top left corner to ensure your database is up to date. If everything works as expected you should then be able to do a search in GNOME software and find your new application showing up.
 ![Example GNOME Software listing](/content/deployment/desktop/example-gnome-software-listing.png  "Example GNOME Software listing")
 

deployment/desktop/how-to-propose-a-3rd-party-application-for-inclusion-in-fedora.md

@@ -9,7 +9,8 @@ order: 6
 ### Getting it into Fedora Workstation
 
 You now have your repository created and ready for users to connect to it. The final step is getting your repository added to Fedora Workstation.
-To start the process for this you can file a [Fedora ticket](https://bugzilla.redhat.com/enter_bug.cgi?product=Fedora) against the Fedora-workstation-repositories component. The information needed is a decription of your application. We also need the URL where the repository is located.
+
+To start the process for this you can file a [Fedora ticket](https://bugzilla.redhat.com/enter_bug.cgi?product=Fedora) against the *fedora-workstation-repositories* component. The information needed is a decription of your application. We also need the URL where the repository is located.
 
 This will allow the Fedora Workstation Working group to review your application and ask any needed follow-up questions. For more in depth-information about the process and rules for including 3rd party software in Fedora Workstation you can see the [Third Party Software for Fedora](https://fedoraproject.org/wiki/Workstation/Third_party_software_proposal) page.
 

deployment/desktop/how-to-setup-and-host-flatpaks.md

@@ -8,25 +8,25 @@ order: 5
 
 ### Flatpak hosting and Metadata
 
-The flatpak-builder binary generates AppStream metadata automatically when building applications if the appstream-compose tool is installed on the flatpak build machine. Flatpak[1] repositories are exported with a separate ‘appstream’ branch which is automatically downloaded by GNOME Software and no additional work is required when building your application or updating the remote. Adding the remote is enough to add the application to the software center, on the assumption the AppData file is valid.
+The *flatpak-builder* binary generates AppStream metadata automatically when building applications if the *appstream-compose* tool is installed on the flatpak build machine. Flatpak[1] repositories are exported with a separate *appstream* branch which is automatically downloaded by GNOME Software and no additional work is required when building your application or updating the remote. Adding the remote is enough to add the application to the software center, on the assumption the AppData file is valid.
 
 Extensive information on building flatpaks and on hosting and signing flatpak repostories can be found elsewhere[2].
+
 In summary, to create an empty repository, you use:
 
         ostree init --mode=archive-z2 --repo=repo
 
-To tell flatpak-builder to import the end result of a build into this repository, you pass --repo=repo:
+To tell flatpak-builder to import the end result of a build into this repository, you pass *--repo=repo*:
 
         flatpak-builder --verbose --force-clean \
-                                --repo=repo \
-                                --gpg-homedir=gpg --gpg-sign=$GPG_KEY \
-                                recipes flatpak/org.gnome.Recipes.json
+            --repo=repo --gpg-homedir=gpg --gpg-sign=$GPG_KEY \
+            recipes flatpak/org.gnome.Recipes.json
 
 To generate appstream branches and static deltas in this repository, you use:
 
         flatpak build-update-repo --generate-static-deltas --gpg-homedir=gpg --gpg-sign=$GPG_KEY repo
 
-Note that both of these commands take a --gpg-sign argument. Flatpak uses GPG as a means to ensure that the repository
+Note that both of these commands take a *--gpg-sign* argument. Flatpak uses GPG as a means to ensure that the repository
 can be trusted, so you should sign your public repositories.
 
 The best way to make your application and its Flatpak repository available to users is to publish a flatpakref file for it:
@@ -43,8 +43,9 @@ The best way to make your application and its Flatpak repository available to us
 
 ### Hosting a Flatpak repository on Github
 
-Github isn't really set up for hosting Flatpak repositories, so we can't guarantee that this will keep working in the future. So once you created a local copy of your repository create a new project on github, enable github pages for the project and point it at the master branch.
-Then use the follow commands to import your repository into github.
+Github isn't really set up for hosting Flatpak repositories, so we can't guarantee that this will keep working in the future. So once you created a local copy of your repository create a new project on Github, enable Github pages for the project and point it at the master branch.
+
+Then use the follow commands to import your repository into Github.
 
 	cd ~/src/myrepository
 	git init
@@ -53,10 +54,7 @@ Then use the follow commands to import your repository into github.
 	git remote add origin [email protected]:yourgitaccount/myrepo.git
 	git push -u origin master
 
-Now you should be able to refer to your repo with a raw.githubusercontent.com/ URL like the one shown in the flatpakrepo
-example above.
-
-The flatpak-builder binary generates AppStream metadata automatically when building applications if the appstream-compose tool is installed on the flatpak build machine. Flatpak[1] remotes are exported with a separate ‘appstream’ branch which is automatically downloaded by GNOME Software and no addition work if required when building your application or updating the remote. Adding the remote is enough to add the application to the software center, on the assumption the AppData file is valid.
+Now you should be able to refer to your repo with a *raw.githubusercontent.com/* URL like the one shown in the flatpakrepo example above.
 
 1. [Flatpak Homepage: 17th October 2016](http://flatpak.org/)