Merge pull request #87 from WindowsMeosu/testingv2

checklist merge
WindowsMeosu · Nov 27, 2023 · cf4740d · cf4740d
2 parents 77d2b07 + 62a191a
commit cf4740d
Show file tree

Hide file tree

Showing 58 changed files with 815 additions and 28 deletions.
diff --git a/.github/funding.yml b/.github/funding.yml
@@ -1,3 +1,4 @@
+patreon: milotilo
 custom: ['https://osu.ppy.sh/store/products/supporter-tag?target=Windows_Me']
 # I'm not accepting any real-life money for this project as I don't know which direction I want peppypedia to go. If you want, feel free to gift me a supporter tag. I'd appreciate knowing that people actually care about peppypedia.
 # in the future, I'd probably allow people to support this project wih real-life currency for a low price of probably 2 dollars or less (I don't ask for much).

diff --git a/.github/labeler.yml b/.github/labeler.yml
@@ -1,5 +1,14 @@
 # Add 'repo' label to any non-docs file changes
 repo:
 - '*'
+- _plugins/**/*
+- .github/**/*
+# if the changes happen in the 'docs' directory
 docs:
 - docs/**/*
+# if changes happen to workflows
+workflow:
+- .github/**/*
+# if changes are api related
+API:
+- docs/api/**/*
diff --git a/README.md b/README.md
@@ -0,0 +1,36 @@
+# peppypedia
+
+peppypedia is not to be a replacement for the osu!wiki.
+
+Note: Some code here may not belong to me.
+IRC: (libera.chat) #peppypedia
+
+If you use gitlab instead of github please go here:
+<https://github.com/WindowsMeosu/peppypedia/tree/master/README.md>
+
+This repo is maintained by WindowsMeosu
+clone or fork this for whatever needs suit you best, to contribute, to mirror peppypedia to make or run your own so-called "peppypedia", etc, etc, etc, etc.
+
+```cmd
+git clone https://github.com/WindowsMeosu/peppypedia
+```
+
+```cmd
+git clone https://github.com/WindowsMeosu/peppypedia.git
+```
+
+```sh
+git clone ssh://github.com/WindowsMeosu/peppypedia
+```
+
+```sh
+sudo git clone https://github.com/WindowsMeosu/peppypedia
+```
+
+```sh
+git clone github:/WindowsMeosu/peppypedia
+```
+
+## Contributors
+
+Please refer to [contributors](./contributors.md).
diff --git a/catschema.xml b/catschema.xml
@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
+<xs:element name="peppy" cat="page" type="xs:user" index="true"/>
+<xs:element name="discoprince" cat="page" type="xs:map" index="true"/>
+<xs:element name="osu!" cat="page" type="xs:mode" index="true"/>
+<xs:element name="zallius" cat="page" type="xs:user" index="true"/>
+<xs:element name="jhlee0133" cat="page" type="xs:user" index="true"/>
+<xs:element name="pagetemplate" cat="page" type="xs:template" index="false"/>
+<xs:element name="osu!mania" cat="page" type="xs:draft" index="false"/>
+<xs:element name="peppypediaisandisnot" cat="page" type="xs:deleted" index="false"/>
+<xs:element name="coe" cat="page" type="xs:page" index="false"/>
+<xs:element name="irc" cat="page" type="xs:page" index="false"/>
+
+<xs:element name="pdata">
+ <xs:complex>
+    <xs:sequence>
+      <xs:element ref="series"/>
+      <xs:element ref="pages"/>
+      <xs:element ref="user"/>
+      <xs:element ref="index"/>
+    </xs:sequence>
+   <xs:attribute page="index" type="xs:markdown" main="required"/>
+   </xs:complex>
+   </xs:element>
+   </xs:schema>
+   <!-- copy from https://github.com/WindowsMeosu/windowsmeosu.github.io/blob/3a2d38a5c14eebb76142c4da88d9303e69609abc/peppypediadata/page_schema.xsd -->
diff --git a/catschema.xsl b/catschema.xsl
@@ -0,0 +1,19 @@
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+                xmlns:xlink="http://www.w3.org/1999/xlink"
+                exclude-result-prefixes="xlink"           
+                version="1.0">
+  <xsl:output method="html"/>
+
+  <xsl:template match="*[@xlink:type = 'simple' and @xlink:href]">
+    <p><a href="{@xlink:href}"><xsl:apply-templates/></a></p>
+  </xsl:template>
+
+  <xsl:template match="*">
+    <html><body>
+      <xsl:apply-templates/>
+    </body></html>
+  </xsl:template>
+
+</xsl:stylesheet>
+
+<!-- available in the root section for a reason -->
diff --git a/contributors.md b/contributors.md
@@ -0,0 +1,50 @@
+# Contributors
+
+## Read first
+
+> There are certain guidelines one must follow whilst creating an article. Please keep these guidelines in mind and note that violating certain guidelines may result in PR closure.
+
+1. user articles (`e.g mrekk`) must document either the following:
+
+- An user who is well known in the community.
+
+- An user who has accomplished something worth documenting. This includes, but not limited to:
+
+1. New record:\
+1.1. Performance Points record.\
+1.2. Highest playcount (counting all or any mode).\
+1.3. `Ranked Score` and/or `Total Score` (e.g: an user breaks the 900bil score barrier).\
+
+2. Development\
+2.1. The user has contributed to the development of osu!(stable) and/or osu!(stream) in the past.\
+2.2. The user is part of the [Performance Points Committee](/wiki/People/Performance_Points_Committee).\
+2.3. The user is part of the developer group.\
+2.4. The user has contributed to lazer in the past or recent months and has enough sources for documention.\
+2.5. The user has made outstanding contributions to the osu! website (osu-web, osu-wiki) and has enough sources for documention.
+
+- Depends on context:
+
+3. Modding\
+3.1. The user has made numerous and outstanding contributions to beatmaps.
+
+- Depends on context:
+
+4. Chat/Forum Moderation\
+4.1. The user has contributed to keeping the chat a safe place via moderation means and has enough sources for documention (Global Moderation Team/Nomination Assessment Team).\
+4.2. The user has contributed to keeping the forums a safe place via moderation means and has enough sources for documention (Global Moderation Team/Nomination Assessment Team).
+
+<p hidden></p>
+
+2. beatmap articles must document either the following:
+
+- A beatmap that has contributed to the history of osu!, and is worth documenting.
+
+3. articles documenting events must document the following:
+
+- World Cup tournaments (osu! World Cup, osu!taiko World Cup, osu!catch World Cup, osu!mania World Cup).
+
+- Known conventions, say `canoe's osu! event`.
+
+4. for articles documenting in-game features:
+
+- Most "in-game features" are bancho-related and go into the `bancho` directory. Features such as the Editor go into the `mapping` directory. If you don't know what directory you should place it in, mention so in the description of your pull request.
diff --git a/discoprince.xml b/discoprince.xml
@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"/>
+<xs:element name="discorpince" cat="page" type="xs:user" index="true"/>
+<xs:metadata name="Disco Prince" categories="maps" docs="true" stub="true" peppypedia-old="true"/>
+<xs:attribute page="index" type="xs:markdown" main="required"/>
+
+   <!-- part of catschema -->
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -41,4 +41,12 @@ categories: user, content, events, users, maps
 output: true
 paginate: 5
 site_root: ./docs
+footer_content: peppypedia, started by Windows Me (windowsmeosu on github) documents top osu! players, in-game features, etc. peppypedia is not a replacement for the osu!wiki. Copyright, MiloTilo Services, BV.
+copyright: MiloTilo Services
+gh_edit_link: true
+gh_edit_link_text: "Edit or add improvisations to this page on GitHub."
+gh_edit_repository: "https://github.com/windowsmeosu/peppypedia"
+gh_edit_branch: "master"
+gh_edit_view_mode: "edit" 
+gh_edit_source: docs
 
diff --git a/docs/api/Akolibed.json b/docs/api/Akolibed.json
@@ -0,0 +1 @@
+{"exists":"true","name":"Akolibed","markup":"html/markdown","author":"none","page creator":"Windows_Me"}
diff --git a/docs/api/Bancho.json b/docs/api/Bancho.json
@@ -0,0 +1 @@
+{"exists":"true","type":"parent","child-pages":"2","markup":"html/markdown","author":"Windows_Me"}
diff --git a/docs/api/COE.json b/docs/api/COE.json
@@ -0,0 +1 @@
+{"exists":"true","name":"canove osu! event","markup":"html/markdown","author":"Windows_Me"}
diff --git a/docs/api/IRC.json b/docs/api/IRC.json
@@ -0,0 +1 @@
+{"exists":"true","name":"Internet Relay Chat","markup":"html/markdown","author":"Windows_Me"}
diff --git a/docs/api/WhiteCat.json b/docs/api/WhiteCat.json
@@ -0,0 +1 @@
+{"exists":"true","name":"WhiteCat","markup":"html/markdown","author":"Windows_Me"}
diff --git a/docs/api/Zallius.json b/docs/api/Zallius.json
@@ -0,0 +1 @@
+{"exists":"true","name":"Zallius","markup":"html/markdown","group":"Global Moderaton Team","author":"Windows_Me"}
diff --git a/docs/api/api.ts b/docs/api/api.ts
@@ -0,0 +1,21 @@
+// values lower than 70.00% typically do not meet peppypedia's standards.
+{"peppy","progress";"60.02%"} // html-based, should rework
+{"disco_prince","progress";"72.05%"}
+{"Zallius","progress";"95.20%"}
+{"jhlee0133","progress";"92.01%"}
+{"WhiteCat","progress";"89.22%"}
+{"Bancho","progress";"87.22%"}
+{"IRC","progress";"96.99%"}
+{"index","progress";"99.92%"}
+{"COE","progress";"86.12%"}
+{"users","progress";"0.00%"}
+{"medals","progress";"0.01%"}
+{"mrekk","progress";"97.56%"}
+{"Akolibed","progress";"0.00%"}
+
+
+
+
+
+
+
diff --git a/docs/api/api.xml b/docs/api/api.xml
@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
+<xs:element name="peppy" version="60.02%" type="xs:user" index="true"/>
+<xs:element name="discoprince" version="72.05%" type="xs:map" index="true"/>
+<xs:element name="Zallius" version="95.20%" type="xs:user" index="true"/>
+<xs:element name="jhlee0133" version="92.01%" type="xs:user" index="true"/>
+<xs:element name="WhiteCat" version="89.22%" type="xs:page" index="true"/>
+<xs:element name="Bancho" version="87.22%" type="xs:page" index="false"/>
+<xs:element name="IRC" version="96.22%" type="xs:page" index="false"/>
+<xs:element name="COE" version="86.12%" type="xs:event" index="false"/>
+<xs:element name="users" version="0.00%" type="xs:page" index="false"/>
+<xs:element name="medals" version="00.01%" type="xs:page" index="false"/>
+<xs:element name="mrekk" version="97.56%" type="xs:user" index="true"/>
+<xs:element name="Akolibed" version="0.00%" type="xs:user" index="false"/>
+<xs:element name="credits" version="99.20%" type="xs:page" index="false"/>
+
+
+
+
diff --git a/docs/api/catschema.ts b/docs/api/catschema.ts
@@ -0,0 +1 @@
+{"catschema";"alpha","version";"0.1","progress";"0.2%"}
diff --git a/docs/api/credits.json b/docs/api/credits.json
@@ -0,0 +1 @@
+{"exists":"true","name":"credits","markup":"html/markdown","author":"Windows_Me"}
diff --git a/docs/api/index.json b/docs/api/index.json
@@ -0,0 +1 @@
+{"exists":"true","type":"index","markup":"html/markdown","author":"Windows_Me"}
diff --git a/docs/api/index.md b/docs/api/index.md
@@ -0,0 +1,65 @@
+---
+title: API docs
+layout: minimal
+nav_exclude: true
+---
+
+<title peppypedia API></title>
+
+<center><h1>peppypedia API</h1></center>
+
+peppypedia API documention\
+Notes: `page creator` value exists only when the `author` value is set to `none` or `unknown`. Please state an username on the pull request body. An exception to this is if the following is already added before the metadata:
+ ```md
+ <t><center>[Your username, do not remove brackets](https://osu.ppy.sh/users/0)</center>
+<link rel="stylesheet" href="../profile.css"></t>
+
+![Your username, do not remove brackets](https://a.ppy.sh/0.jpeg#author "Your username")
+```
+
+Should we fail to verify that the user profile linked belongs to you, a direct message will be sent to the user in question. If chat message are set to friends-only, we ask that you temporary allow direct messages from anyone, or direct message [Windows Me](<https://osu.ppy.sh/users/28893698>) yourself.
+
+If the page is a documention page or a parent page, author values aren't required (and should not be added for the former). Should a page be entirely rewritten, the author value will change.
+
+<center><h2>Users</h2></center>
+
+if `exists` is set to value `true`, this indicates that the endpoint exists. markup value should always be `html/markdown`. `group` can be have multiple values:
+
+```json
+"group":"ppy" = peppy
+"group":"SPT" = Support Team
+"group":"Support Team" = Support Team
+"group":"GMT" = Global Moderation Team
+"group":"Global Moderation Team" = Global Moderaton Team
+"group":"NAT" = Nomination Assessment Team
+"group":"Nomination Assessment Team" = Nomination Assessment Team
+(note: "mode" + gamemode should be inputted after if the group is set to BN, TrialBN, NAT, or BSC)
+"group":"TrialBN" = Trial Beatmap Nominator
+"group":"Trial Beatmap Nominator" = Trial Beatmap Nomnator
+(note: "mode" + gamemode should be inputted after if the group is set to BN, TrialBN, NAT, or BSC)
+"group":"BN" = Beatmap Nominator
+"group":"Beatmap Nominator" = Beatmap Nominator
+(note: "mode" + gamemode should be inputted after if the group is set to BN, TrialBN, NAT, or BSC)
+"group":"DEV" = Developer
+"group":"Developer" = Developer
+"group":"BSC" = Beatmap Spotlight Curators
+"group":"Beatmap Spotlight Curators" = Beatmap Spotlight Curators
+(note: "mode" + gamemode should be inputted after if the group is set to BN, TrialBN, NAT, or BSC)
+```
+
+
+```sh
+curl --request GET \
+    --get "https://milotilo.ddns.net/peppypedia/api/peppy.json" \
+    --header "Content-Type: application/XML" \
+    --header "Accept: application/XML"
+```
+
+response:
+
+```json
+{"exists":"true","name":"peppy","markup":"html/markdown","group":"ppy","author":"Windows_Me"}
+```
+
+API progress can be seen [here](index.ts.json).\
+page completion progress can be seen [here](api.xml)
diff --git a/docs/api/index.ts b/docs/api/index.ts
@@ -0,0 +1,2 @@
+{"api";"catschema";"lang";"XML/JSON"}
+{"progress","users";"2.5%","beatmaps";"0.00%","medals","0.01%","TOCS";"92.00%","Bancho";"2.1%"}
diff --git a/docs/api/index.ts.json b/docs/api/index.ts.json
@@ -0,0 +1 @@
+{"api":"catschema","lang":"XML/JSON","progress":"users","2.5%":"beatmaps","0.00%":"medals","0.01%":"TOCS","92.00%":"Bancho","2.1%":"progress"}
diff --git a/docs/api/jhlee0133.json b/docs/api/jhlee0133.json
@@ -0,0 +1 @@
+{"exists":"true","name":"jhlee0133","markup":"html/markdown","author":"Windows_Me"}
diff --git a/docs/api/medals.json b/docs/api/medals.json
@@ -0,0 +1 @@
+{"exists":"true","type":"parent","child-pages":"1","nav_exclude":"true","markup":"html/markdown","author":"Windows_Me"}
diff --git a/docs/api/mrekk.json b/docs/api/mrekk.json
@@ -0,0 +1 @@
+{"exists":"true","name":"mrekk","markup":"html/markdown","author":"Windows_Me"}
diff --git a/docs/api/peppy.json b/docs/api/peppy.json
@@ -0,0 +1 @@
+{"exists":"true","name":"peppy","markup":"html/markdown","group":"ppy","author":"Windows_Me"}
diff --git a/docs/api/peppypedia.json b/docs/api/peppypedia.json
@@ -0,0 +1 @@
+{"exists":"true","type":"index","markup":"html/markdown","author":"Windows_Me"}
diff --git a/docs/api/users.json b/docs/api/users.json
@@ -0,0 +1 @@
+{"exists":"true","type":"parent","child-pages":"none","nav_exclude":"true","markup":"html/markdown","author":"Windows_Me"}
diff --git a/docs/assets/css/round-images.css b/docs/assets/css/round-images.css
@@ -0,0 +1,11 @@
+.image-rounded {
+	border-radius: 4px;
+	display: inline-block;
+}
+
+.image-rounded img {
+	visibility: hidden;
+}
+
+
+
diff --git a/docs/catschema/index.xml b/docs/catschema/index.xml
@@ -0,0 +1,7 @@
+<?xml-stylesheet type="text/xsl" href="index.xsl"?>
+ <schema xmlns:xlink="http://www.w3.org/1999/xlink">
+  <para>catschema version:</para>
+  <sch xlink:href="https://github.com/WindowsMeosu/peppypedia/blob/70-peppypedia-todo-checklist/catschema.xml"
+          xlink:type="simple">version 0.1</sch>
+
+</schema>
diff --git a/docs/catschema/index.xsl b/docs/catschema/index.xsl
@@ -0,0 +1,17 @@
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+                xmlns:xlink="http://www.w3.org/1999/xlink"
+                exclude-result-prefixes="xlink"           
+                version="1.0">
+  <xsl:output method="html"/>
+
+  <xsl:template match="*[@xlink:type = 'simple' and @xlink:href]">
+    <p><a href="{@xlink:href}"><xsl:apply-templates/></a></p>
+  </xsl:template>
+
+  <xsl:template match="sch">
+    <html><body>
+      <xsl:apply-templates/>
+    </body></html>
+  </xsl:template>
+
+</xsl:stylesheet>