From 5e7a3941bcbc472dd797656b9a0b7adbdff4c325 Mon Sep 17 00:00:00 2001 From: Jan Kuparinen Date: Jan 26 2021 07:00:52 +0000 Subject: Framework for gaming documentation --- diff --git a/antora.yml b/antora.yml index 58b14fc..2d25ecc 100644 --- a/antora.yml +++ b/antora.yml @@ -3,7 +3,7 @@ name: gaming # <---- PLEASE MODIFY # Title will be visible on the page. -title: Fedora gaming documentation # <---- PLEASE MODIFY +title: Fedora gaming # <---- PLEASE MODIFY # If you don't plan to have multiple versions of the docs (for example, to document multiple versions of some software), you can ignore this field. Otherwise, change "master" to a specific version. version: master diff --git a/modules/ROOT/assets/images/pizza.png b/modules/ROOT/assets/images/pizza.png deleted file mode 100644 index bdecba7..0000000 Binary files a/modules/ROOT/assets/images/pizza.png and /dev/null differ diff --git a/modules/ROOT/assets/images/super_mario.png b/modules/ROOT/assets/images/super_mario.png new file mode 100644 index 0000000..098d876 Binary files /dev/null and b/modules/ROOT/assets/images/super_mario.png differ diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index 0cefda4..86165a3 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -1,5 +1,9 @@ -* xref:architecture.adoc[Architecture] -** xref:pizza-oven.adoc[Pizza Oven] -** xref:pizza-dough.adoc[Pizza Dough] +* xref:index.adoc[Mission] +* xref:communicating.adoc[Getting in touch] +* xref:contributing.adoc[Join us] +* xref:gamelinks.adoc[Gaming links] +** xref:gamesites.adoc[Gaming news sites] +** xref:gamelists.adoc[Game list references] +* xref:gameinstallation.adoc[Installations] * xref:community.adoc[Community] * xref:faq.adoc[FAQ] diff --git a/modules/ROOT/pages/architecture.adoc b/modules/ROOT/pages/architecture.adoc deleted file mode 100644 index 687e4b0..0000000 --- a/modules/ROOT/pages/architecture.adoc +++ /dev/null @@ -1,3 +0,0 @@ -= Pizza Factory Architecture - -The architecture of our pizza factory is quite simple. We bake our very expensive xref:pizza-dough.adoc[pizza dough] in a very cheap xref:pizza-oven.adoc[pizza oven]. This way, we can achieve a medicore result for a high price and a reasonable number of failures. diff --git a/modules/ROOT/pages/communicating.adoc b/modules/ROOT/pages/communicating.adoc new file mode 100644 index 0000000..889e1ab --- /dev/null +++ b/modules/ROOT/pages/communicating.adoc @@ -0,0 +1,24 @@ += Communicating and getting help + + + +For general troubleshooting help related to Fedora, please refer to link:https://ask.fedoraproject.org[ask Fedora forum]. + +If you found a bug, report it + +* link:https://docs.fedoraproject.org/en-US/quick-docs/howto-file-a-bug/[How to file a bug]. + +For anything related to gaming, please use the following channels: + +* Join us at link:https://discussion.fedoraproject.org/c/desktop/gaming[gaming discussion forum]. + + +* Issues about gaming documentation can be filed at link:https://pagure.io/gaming/documentation/issues[ticketing repository on Pagure]. + + +* You can chat with us at link:https://webchat.freenode.net/?channels=#fedora-games[#fedora-games on irc.freenode.net], or our link:https://matrix.to/#/!duZFcjensgiBWcrjwO:matrix.org?via=matrix.org&via=t2bot.io[Element/Matrix channel]. Chats are bridged so you can use either one of them. + +* You can e-mail us on the Games mailing list at link:https://lists.fedoraproject.org/admin/lists/games@lists.fedoraproject.org/[games@lists.fedoraproject.org]. + + + diff --git a/modules/ROOT/pages/community.adoc b/modules/ROOT/pages/community.adoc index def9977..664c472 100644 --- a/modules/ROOT/pages/community.adoc +++ b/modules/ROOT/pages/community.adoc @@ -1,3 +1,3 @@ -= Pizza Factory Community += Gaming Community -Our community is basically the same as the community of Fedora Docs. That's mostly because this is a template for new pieces of the Fedora Docs. +Our community is being revitalized. diff --git a/modules/ROOT/pages/contributing.adoc b/modules/ROOT/pages/contributing.adoc new file mode 100644 index 0000000..31e7fa4 --- /dev/null +++ b/modules/ROOT/pages/contributing.adoc @@ -0,0 +1,20 @@ += Contributing + +:toc: macro + +:toc-title: Contents + + + +NOTE: A link:https://admin.fedoraproject.org/accounts/[Fedora account] is required to access the link:https://apps.fedoraproject.org/[applications] and link:https://fedoraproject.org/wiki/Infrastructure[infrastructure] used by the Fedora community. It only takes a minute to set up! You can learn more about the Fedora project link:https://docs.fedoraproject.org/en-US/project/[here]. + + + +Games interest group is a community supported initiative, and team members work on it in their free time. + +We are always looking for more hands to help with gaming, and we are more than happy to help people learn the technical skills required to contribute. + +Please xref:communicating.adoc[get in touch] if you would like to join the team! + + + diff --git a/modules/ROOT/pages/gameinstallation.adoc b/modules/ROOT/pages/gameinstallation.adoc new file mode 100644 index 0000000..fc6d8a6 --- /dev/null +++ b/modules/ROOT/pages/gameinstallation.adoc @@ -0,0 +1,3 @@ +== Game installation + +* https://fedoraproject.org/wiki/Games[Old games wiki] \ No newline at end of file diff --git a/modules/ROOT/pages/gamelinks.adoc b/modules/ROOT/pages/gamelinks.adoc new file mode 100644 index 0000000..2e3986f --- /dev/null +++ b/modules/ROOT/pages/gamelinks.adoc @@ -0,0 +1 @@ +== Some gaming links \ No newline at end of file diff --git a/modules/ROOT/pages/gamelists.adoc b/modules/ROOT/pages/gamelists.adoc new file mode 100644 index 0000000..9b5508e --- /dev/null +++ b/modules/ROOT/pages/gamelists.adoc @@ -0,0 +1,12 @@ +== Game List References + +* https://www.allegro.cc/[Allegro games] Instructions: genre -> listing +-> show options -> "Source" to "yes" -> Apply +* https://packages.debian.org/unstable/games/[Debian games] +* https://openarena.wikia.com/wiki/OtherOpenSourceShooter[First-person +shooters] with different levels of Freeness +* https://libregamewiki.org/List_of_games[Libre game wiki's list of +games] +* https://icculus.org/lgfaq/gamelist.php[Linux Gamers' Game List] +* https://en.wikipedia.org/wiki/List_of_open-source_video_games[List of +open source video games] at Wikipedia diff --git a/modules/ROOT/pages/gamesites.adoc b/modules/ROOT/pages/gamesites.adoc new file mode 100644 index 0000000..2a37559 --- /dev/null +++ b/modules/ROOT/pages/gamesites.adoc @@ -0,0 +1,8 @@ +== Gaming News sites + +* https://freegamer.blogspot.com/[Free Gamer] +* https://libregamewiki.org/[Libregamewiki] +* https://www.mobygames.com/browse/games/linux/[Linux games at +MobyGames] CONTAINS NON FREE SOFTWARE +* https://www.linuxgaming.de/[1] (German with Wiki, Forum and News) +* https://unixgames.org[Unixgames Q&A] \ No newline at end of file diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc index b890d2a..f587212 100644 --- a/modules/ROOT/pages/index.adoc +++ b/modules/ROOT/pages/index.adoc @@ -1,9 +1,29 @@ -= The Pizza Project -John Doe; Jane Doe += Fedora gaming documentation +Jan Kuparinen; Games SIG :page-authors: {author}, {author_2} -The Pizza Project is a useful project with a very bad name — it helps you with writing some new documentation for Fedora. +== Mission -In fact, this is just a source template for a new piece of the Fedora Docs. +Goal: to make Fedora the best Free software and open source gaming +platform there is for both developers and users. -image::pizza.png[Pizza] +We aim to accomplish this goal through a variety of activities: + +* Creating high quality packages of games, gaming-related libraries, and +game development tools +* Documenting the available games, including wiki documentation and +listing in comps.xml +* Providing a forum where users and developers can discuss issues +related to current games, requests for new games to be packaged, and +game packaging issues (but not game playing help, so don't bother asking +how to kill the wumpus!) +* Seeking publicity for games in Fedora +* Actively review each other's game packages to shorten the time it +takes to get games approved and imported into Fedora Package Collection +* Design additional guidelines on top of the Fedora Packaging guidelines +that are specific to games +* Help each other fix bugs that have been filed against game packages +* Alerting each other about orphaned and soon-to-be orphaned games so +that we can prevent their removal + +image::super_mario.png[Gaming] diff --git a/modules/ROOT/pages/pizza-dough.adoc b/modules/ROOT/pages/pizza-dough.adoc deleted file mode 100644 index 5b59bae..0000000 --- a/modules/ROOT/pages/pizza-dough.adoc +++ /dev/null @@ -1,3 +0,0 @@ -= Pizza Dough Architecture - -I would never thought that a pizza dough can have an architecture. Yet here we are. diff --git a/modules/ROOT/pages/pizza-oven.adoc b/modules/ROOT/pages/pizza-oven.adoc deleted file mode 100644 index ad460cd..0000000 --- a/modules/ROOT/pages/pizza-oven.adoc +++ /dev/null @@ -1,3 +0,0 @@ -= Pizza Oven Architecture - -Pizza oven architecture would be described on this page. Since this is just a template, I choose to disappoint you and not describe the pizza oven architecture. diff --git a/site.yml b/site.yml index 2c197d3..98babbf 100644 --- a/site.yml +++ b/site.yml @@ -1,5 +1,5 @@ site: - title: Local Preview - Fedora gaming documentation + title: Local Preview - Fedora gaming start_page: gaming::index content: sources: