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

Update Formatting Policy & Add New Editing Guide #94

Open
5 tasks
shooter7620 opened this issue Jan 20, 2025 · 4 comments
Open
5 tasks

Update Formatting Policy & Add New Editing Guide #94

shooter7620 opened this issue Jan 20, 2025 · 4 comments
Assignees
Labels
priority:medium good to have in the near future

Comments

@shooter7620
Copy link

shooter7620 commented Jan 20, 2025

we're moving off of MediaWiki and using a different framework which doesn't have the same features that MediaWiki has, the whole of the formatting policy now effectively needs a rewrite… again.

On top of that we're going to need to make a new editing guide from scratch, as we can't exactly rely on the MediaWiki editing guide anymore… at all. We're going to need to familiarize people with interacting with GitHub, on top of editing files that are directly used for their relevant pages.

I'll try to get started on this, but as I currently don't have access to my own PC for the foreseeable future, it may be a slow process.

Edit: Looks like I failed to notice the already existing editing guide here. Regardless, it is not entirely finished and will need work once I am familiar with editing the wiki here.

Progress:

  • Transfer root formatting policy page
  • Update and maintain new editing guide (resolve other issues first if necessitated)
  • Rewrite ships formatting policy
  • Rewrite planet/base formatting policy in accordance with modifications made to the ships formatting policy
  • Rewrite clan/player faction formatting policy
@shooter7620 shooter7620 added the priority:medium good to have in the near future label Jan 20, 2025
@shooter7620 shooter7620 self-assigned this Jan 20, 2025
@donthaveausername
Copy link

can help with this, let me know what exactly you need

@shooter7620
Copy link
Author

@donthaveausername The baseline goal is to include at least the details regarding page structure and basic advice that still applies from the previous formatting policy.

An example of something that would now be obsolete are references to (almost) anything MediaWiki, since we don't use that software anymore. On the other hand, we want to preserve page structures previously detailed in the formatting policy, such as for example, the sections of ship pages, their order, and the general type of content included within each section.

To start with, the root formatting policy page can be practically transferred over with some editing, as that is the page with the least amount of corrections required. That can be followed by the ships formatting policy, which is unfortunately going to take the most amount of time as it has quite a bit of content that needs to be rewritten (template usage, references, parser tags, etc). Afterwards it will likely be easy to transfer the remaining planet/base and clan/player faction formatting policies.

You can start with any page, but I would advise starting with the top-level formatting policy page first.

I'll update the original comment with some checklists just to establish some sort of tracker for progress on the issue.

@shooter7620
Copy link
Author

Caveats

  • The structure of pages has changed (somewhat), and is much more minimalized in terms of tags used within page content. The ships formatting policy will need to reflect that, which may require feedback regarding the direction to go with rewriting it.
  • The current editing guide needs to be reviewed for the purpose of updating the formatting policy, but it also should not remain the stand-in for the formatting policy after it is established on this version of the wiki (refactor it to specifically talk about editing on GitHub/editing with Git as well as familiarization with the new interface along with new tooling specific to this version of the wiki).

@donthaveausername
Copy link

i'll start by editing and transferring the root policy page

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority:medium good to have in the near future
Projects
Status: Todo
Development

No branches or pull requests

2 participants