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

Misc. formatting issues & wanted CI checks #2275

Open
cl8n opened this issue May 26, 2019 · 6 comments
Open

Misc. formatting issues & wanted CI checks #2275

cl8n opened this issue May 26, 2019 · 6 comments
Assignees
Labels
area:meta non-article files epic big boy with many tasks

Comments

@cl8n
Copy link
Member

cl8n commented May 26, 2019

this is tracking both the issues in files and (lack of) warnings in linting tools. some of these don't need linting checks, e.g. fixing leftovers of very old issues that won't come up again. some can be crossed off after a linting check is made, regardless of existing issues in files. some may require changes to ASC. some may easily be adopted into remark's markdown output.

  • don't allow links to files that can't be served from wiki
  • Use sentence case for article titles and directory names
  • Make article titles unique
  • Article titles should not depend on parent paths for context
    (e.g. for an article at RC/osu!, it should be called "osu! ranking criteria", not "osu!")
  • News date should be same as date in filename
  • News date should be same as date in linked directory under /wiki/shared/news
  • Put osu.ppy.sh in front of osu! links
  • Remove code styling from headers
  • Remove other kinds of whitespace not in ASCII
  • Strip BOM
  • Strip whitespace from beginnings and ends of files
  • Ensure correct spacing between yaml blocks and content
  • Remove trailing (single) spaces
  • Remove trailing (non-single) whitespace that doesn't do anything
  • Standardize image filenames (only hyphens for separating words) + ASC
  • Match article titles to their folder names (except cases where it makes sense to have different)
  • Link users/beatmaps/etc by ID instead of name
  • Limit word boundary whitespace to a single space in normal paragraphs
  • Don't use horizontal rules before headers
  • Remove slashes from anchors
  • Remove trailing slashes from wiki and osu links
  • Convert /beatmaps/ links into /beatmapsets/
  • Handle special variables (?m=0, etc) on /beatmap(set)s and /users
  • Point /p/ links to new site
  • Point /forum/ links to new site (foes links are still not changed)
  • sentence case headers
  • sentence case article titles
  • enforce redirects being made when articles are moved or deleted
  • require English locale for every article
  • titles must be unique
  • images go in img folders within articles
  • no character references except maybe  
  • no percent encoding or character references in link destination
  • all leaf blocks (::) must be country flags
  • all blocks (:::) must be valid styleblocks
  • match custom IDs between languages
  • list conventions in 48475ed
@MegaApplePi
Copy link
Contributor

Single-space lists

So, we going with single spaces for lists?

nts I wrote a thing explaining why I thought we should use 4 characters. Only to cut myself off, realising that it is some kind of hypothetical that would only occur if we are in need of long and heavily indented lists. /shrug

@cl8n
Copy link
Member Author

cl8n commented May 27, 2019

oh that is sort of misleading how I wrote it sorry. i dont mean the indenting, I mean the amount of blank lines between bullets in a list (nearly all lists should have no blank lines, but some do for seemingly no reason)

@cl8n cl8n added this to the Backlog milestone Sep 5, 2019
@cl8n cl8n self-assigned this Sep 6, 2019
@cl8n cl8n modified the milestones: Backlog, January 2020 Dec 2, 2019
@cl8n cl8n modified the milestones: January 2020, Backlog Jan 24, 2020
@cl8n cl8n added the epic big boy with many tasks label Jan 30, 2020
@TPGPL TPGPL self-assigned this Jan 30, 2020
@cl8n cl8n added the area:meta non-article files label Feb 10, 2020
@cl8n cl8n removed this from the Backlog milestone Nov 15, 2020
@TicClick
Copy link
Contributor

@cl8n this is something you have the most context for -- wanna tick some boxes/add short explanations for what needs to be done, so that others could pick some tasks up?

@cl8n
Copy link
Member Author

cl8n commented Nov 25, 2021

i don't think there is more explanation to add to these, they are all as straightforward as written, just annoying or very time consuming to apply across the whole wiki and verify that it was done correctly. iirc this was related to a remark extension i was working on at the time as well

the list is probably pretty outdated at this point. issue was last edited july 2020 and I haven't been keeping up

@TicClick
Copy link
Contributor

to put it another way, I don't understand the following items:

  • Put osu.ppy.sh in front of osu! links
  • Fix old MediaWiki image entries
  • Handle news.ppy.sh links
  • Handle w.ppy.sh images
  • Other MediaWiki things (expand this later)
  • enforce sitemap being changed

@TPGPL
Copy link
Contributor

TPGPL commented Nov 26, 2021

  • Put osu.ppy.sh in front of osu! links - for some time we were stripping the osu.ppy.sh URL from all links pointing to the osu! site; at last that was reverted and there are no more occurrences of that iirc?
  • enforce sitemap being changed is from a time when the sitemap was maintained manually so this one is done too
  • Handle news.ppy.sh links - alternative links pointing to news posts, fixed already
  • Handle w.ppy.sh images - a leftover from MediaWiki - some images were displayed through links, not files in the repo; fixed already
  • Fix old MediaWiki image entries - some images had weird MediaWiki leftovers like fig: in tooltips, should be fixed already as well?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:meta non-article files epic big boy with many tasks
Projects
None yet
Development

No branches or pull requests

5 participants