Wiki Updates: Difference between revisions

From Resonite Wiki
Created page with " These notes are mostly, copied from Discord. == Launch(2024-01-11) == This is copied from the Discord from prime: Hey Everyone, the wiki is now open and launched. It can be accessed at (You're reading it) . As a reminder some items from the GH Issue: Documentation is NOT finished Anyone can edit the wiki The wiki is a community project, you can contribute. This is just the start of the wiki, big changes are due for almost every page. While anyone can edit the wik..."
 
No edit summary
 
(22 intermediate revisions by 3 users not shown)
Line 1: Line 1:


These notes are mostly, copied from [https://discord.com/channels/1040316820650991766/1154514026177507438 Discord].


== 2024-06-03 ==
Its been awhile so I wanted to provide a couple of updates:
* We've corrected the Cron Job that maintains the [https://www.mediawiki.org/wiki/Manual:Job_queue wiki's Job Queue]. It kept breaking, now its fixed
* We've added a notice to the edit interface of each page, which tells people about the contributing guide and our moderation system.


These notes are mostly, copied from Discord.
== 2024-02-27 ==
Thanks to some persistence from @PJB we now have image thumbnails in our search results:


== Launch(2024-01-11) ==
Enjoy!
This is copied from the Discord from prime:
 
It will pick the "most relevant image" see: https://www.mediawiki.org/wiki/Extension:PageImages for more info
 
 
== 2024-02-06 ==
I've added Mermaid Support see, the [https://github.com/SemanticMediaWiki/Mermaid/blob/master/docs/USAGE.md extension usage documentation] and the [https://mermaid.js.org/intro/ Official Mermaid Docs]
 
 
== 2024-01-30 ==
We now have backups running in two methodologies, 1 public 1 private.
 
You can access info about this here: [[Resonite_Wiki:Backups]].
 
Which includes a link to the public backups which you can download whenever you want!
 
== 2024-01-24 (Again) ==
We've updated the translation extension and modified some of the CSS to get nice looking circles for translation progress rather than weird square images. They look a lot better!
 
== 2024-01-24 ==
Ok all clear.
 
We are now running MediaWiki 1.42, this is the latest release from MediaWiki. I didn't really want to upgrade so soon but this allows a bunch of Extensions to work correctly including:
* [https://www.mediawiki.org/wiki/Extension:CharInsert Extension:CharInsert] - Which created the edit buttons below in source view, these are very useful (video soon), they are ugly yes, I'll fix that soon.
* Advanced Search - This one is a little complicated so isn't enabled just yet but it should sort out our search woes.
 
I apologize for the delay in getting things updated, it was a minor release but a lot of extensions were broken and throwing errors, I've fixed that but did have to disable a few extensions until I can figure out why they are broken.
 
I need a couple of hours break from work stuff after the stress of fixing this, but I'll be back to working on fixes soon. Keep your feedback coming in. Editing the wiki and making it better for you all is very motivating right now so I have no plans to stop.
 
Keep it up!
 
== 2024-01-19 ==
I have moved all components to the "Component" namespace.
I have moved all protoflux nodes to the "ProtoFlux" namespace.
 
You can read about namespaces here: https://www.mediawiki.org/wiki/Manual:Namespace
 
Or on our page [[Help:Namespace]]
 
There are several benefits:
* Very simple to filter searches, tools, apis, etc by Namespace
* Sometimes the brackets in (Component) etc, cause issues in URL formatting which I never like.
 
== 2024-01-18 (Translations!) ==
We've opened up translations for all users, do keep in mind our [[Help:Translating|Guidance]] on how to to translate though.
 
== 2024-01-18 ==
* Chroma, Froox and I spoke, and we've swapped the logo back to the rainbow.
* I reconfigured the discord bot to actually ignore the Translation namespace.
** This means individual translations won't go to wiki-log BUT full pages will
** e.g. Translations:Resonite Team/124/fr won't, but Resonite Team/fr will
* I also PR'ed some documentation improvements to the [https://github.com/jayktaylor/mw-discord/pull/59 Discord Wiki extension].
 
 
== 2024-01-18 (I haven't slept yet, I will soon) ==
* Fixed the statistics panel on the top left
* Discovered [https://github.com/jayktaylor/mw-discord/issues/57 a bug] in the Discord Extension]
* PR'ed a [https://github.com/jayktaylor/mw-discord/pull/58 fix to the extension].
 
== 2024-01-17(Again) ==
Ok another update:
* Configured the job queue to actually run (this will fix a bunch of issues you might have noticed)
* Configured the translation extension(still hold off on translating right now, I want to write some guidance to make things smoother)
* Re-configured the Discord extension to skip translations and bot edits
* Tweaked the CSS of the Translation extension to make it easier to see the language selector
* Tweaked the CSS of the edit buttons to be a little better color wise.
 
== 2024-01-17 ==
I've added the following extensions:
* https://github.com/alex-mashin/InlineSVG which allows for Inline SVG see [[Test:SVG]]
* https://www.mediawiki.org/wiki/Extension:NativeSvgHandler which will allows your browser to render SVGs
* I've also allowed SVG uploads.
 
== 2024-01-15 ==
I've enabled Wiki Moderators to also flag users as auto-moderated. This should speed up approvals.


Hey Everyone, the wiki is now open and launched.
Ok random updates:
* Defaulted the theme to dark
* Logos replaced with Official Branding Assets
* Chroma checked my colors, I'll likely still tweak the buttons though a little.


It can be accessed at (You're reading it) .
== 2024-01-13 (Again) ==
Further update, requested by [[User:I'm_Erin.]]


As a reminder some items from the GH Issue:
I've upped the page size limits for the visual editor, this will allow you to use the visual editor to edit the FAQ page.
Documentation is NOT finished
Anyone can edit the wiki
The wiki is a community project, you can contribute.
This is just the start of the wiki, big changes are due for almost every page.


While anyone can edit the wiki, your first few edits will be going through a moderation queue, this queue just prevents your edits from being "live" until they are reviewed. In 90% of cases your first edit will lead to you being cleared to work on the wiki without moderation review in the future.  
However, the recommendation from my research is that the FAQ is tooo big and that we should split it up.


You register with a normal account at the moment, Resonite account linking is Soon TM.
Ok i've made some css changes to the wiki, to more closely align to Resonite's color scheme, Chroma will probably tell me to change them later


Please check: [[Wiki Status]] for a list of known issues and plans.
== 2024-01-13 ==
I've enabled: [https://www.mediawiki.org/wiki/Extension:ShortDescription ShortDescription] which allows you to give each page a short description, these have the ability to show up in search results within the skin that we're using.


Please discuss wiki things in ⁠📖wiki , I'd encourage threads too.
A new writing guideline:
There's also ⁠wiki-log which lists changes to the wiki automatically. I think its cool as it builds excitement about people changing things.
* Avoid using "Click here" or "here" or "page"
** Instead try incorporating the name of the article or link into the sentence.
** Click here to read about bot commands => Bot commands allow you to do cool things
** There's an [https://heyoka.medium.com/dont-use-click-here-f32f445d1021 article], that explains more.


Quick Update here because I forgot:
There also appears to be a way to get search results to have an image, I'll find out what's going on there.
I'd like to thank a bunch of Durian users who helped get this working. They know who they are.


== 2024-01-12 ==
== 2024-01-12 ==
Line 41: Line 124:
* Asking questions about how to edit, or how best to format etc is fine. But for the most part just edit it.
* Asking questions about how to edit, or how best to format etc is fine. But for the most part just edit it.


== 2024-01-13 ==
== Launch(2024-01-11) ==
I've enabled: [https://www.mediawiki.org/wiki/Extension:ShortDescription ShortDescription]] which allows you to give each page a short description, these have the ability to show up in search results within the skin that we're using.


A new writing guideline:
Hey Everyone, the wiki is now open and launched.
* Avoid using "Click here" or "here" or "page"
** Instead try incorporating the name of the article or link into the sentence.
** Click here to read about bot commands => Bot commands allow you to do cool things
** There's an [https://heyoka.medium.com/dont-use-click-here-f32f445d1021 article], that explains more.


There also appears to be a way to get search results to have an image, I'll find out what's going on there.
It can be accessed at (You're reading it) .


== 2024-01-13 (Again) ==
As a reminder some items from the GH Issue:
Further update, requested by [[User:I'mErin.]]
Documentation is NOT finished
Anyone can edit the wiki
The wiki is a community project, you can contribute.
This is just the start of the wiki, big changes are due for almost every page.


I've upped the page size limits for the visual editor, this will allow you to use the visual editor to edit the FAQ page.
While anyone can edit the wiki, your first few edits will be going through a moderation queue, this queue just prevents your edits from being "live" until they are reviewed. In 90% of cases your first edit will lead to you being cleared to work on the wiki without moderation review in the future.  


However, the recommendation from my research is that the FAQ is tooo big and that we should split it up.
You register with a normal account at the moment, Resonite account linking is Soon TM.


Ok i've made some css changes to the wiki, to more closely align to Resonite's color scheme, Chroma will probably tell me to change them later
Please check: [[Wiki Status]] for a list of known issues and plans.


== 2024-01-15 ==
Please discuss wiki things in ⁠📖wiki , I'd encourage threads too.
I've enabled Wiki Moderators to also flag users as auto-moderated. This should speed up approvals.
There's also ⁠wiki-log which lists changes to the wiki automatically. I think its cool as it builds excitement about people changing things.


Ok random updates:
Quick Update here because I forgot:
* Defaulted the theme to dark
I'd like to thank a bunch of Durian users who helped get this working. They know who they are.
* Logos replaced with Official Branding Assets
* Chroma checked my colors, I'll likely still tweak the buttons though a little.





Latest revision as of 23:58, 3 June 2024

These notes are mostly, copied from Discord.

2024-06-03

Its been awhile so I wanted to provide a couple of updates:

  • We've corrected the Cron Job that maintains the wiki's Job Queue. It kept breaking, now its fixed
  • We've added a notice to the edit interface of each page, which tells people about the contributing guide and our moderation system.

2024-02-27

Thanks to some persistence from @PJB we now have image thumbnails in our search results:

Enjoy!

It will pick the "most relevant image" see: https://www.mediawiki.org/wiki/Extension:PageImages for more info


2024-02-06

I've added Mermaid Support see, the extension usage documentation and the Official Mermaid Docs


2024-01-30

We now have backups running in two methodologies, 1 public 1 private.

You can access info about this here: Resonite_Wiki:Backups.

Which includes a link to the public backups which you can download whenever you want!

2024-01-24 (Again)

We've updated the translation extension and modified some of the CSS to get nice looking circles for translation progress rather than weird square images. They look a lot better!

2024-01-24

Ok all clear.

We are now running MediaWiki 1.42, this is the latest release from MediaWiki. I didn't really want to upgrade so soon but this allows a bunch of Extensions to work correctly including:

  • Extension:CharInsert - Which created the edit buttons below in source view, these are very useful (video soon), they are ugly yes, I'll fix that soon.
  • Advanced Search - This one is a little complicated so isn't enabled just yet but it should sort out our search woes.

I apologize for the delay in getting things updated, it was a minor release but a lot of extensions were broken and throwing errors, I've fixed that but did have to disable a few extensions until I can figure out why they are broken.

I need a couple of hours break from work stuff after the stress of fixing this, but I'll be back to working on fixes soon. Keep your feedback coming in. Editing the wiki and making it better for you all is very motivating right now so I have no plans to stop.

Keep it up!

2024-01-19

I have moved all components to the "Component" namespace. I have moved all protoflux nodes to the "ProtoFlux" namespace.

You can read about namespaces here: https://www.mediawiki.org/wiki/Manual:Namespace

Or on our page Help:Namespace

There are several benefits:

  • Very simple to filter searches, tools, apis, etc by Namespace
  • Sometimes the brackets in (Component) etc, cause issues in URL formatting which I never like.

2024-01-18 (Translations!)

We've opened up translations for all users, do keep in mind our Guidance on how to to translate though.

2024-01-18

  • Chroma, Froox and I spoke, and we've swapped the logo back to the rainbow.
  • I reconfigured the discord bot to actually ignore the Translation namespace.
    • This means individual translations won't go to wiki-log BUT full pages will
    • e.g. Translations:Resonite Team/124/fr won't, but Resonite Team/fr will
  • I also PR'ed some documentation improvements to the Discord Wiki extension.


2024-01-18 (I haven't slept yet, I will soon)

2024-01-17(Again)

Ok another update:

  • Configured the job queue to actually run (this will fix a bunch of issues you might have noticed)
  • Configured the translation extension(still hold off on translating right now, I want to write some guidance to make things smoother)
  • Re-configured the Discord extension to skip translations and bot edits
  • Tweaked the CSS of the Translation extension to make it easier to see the language selector
  • Tweaked the CSS of the edit buttons to be a little better color wise.

2024-01-17

I've added the following extensions:

2024-01-15

I've enabled Wiki Moderators to also flag users as auto-moderated. This should speed up approvals.

Ok random updates:

  • Defaulted the theme to dark
  • Logos replaced with Official Branding Assets
  • Chroma checked my colors, I'll likely still tweak the buttons though a little.

2024-01-13 (Again)

Further update, requested by User:I'm_Erin.

I've upped the page size limits for the visual editor, this will allow you to use the visual editor to edit the FAQ page.

However, the recommendation from my research is that the FAQ is tooo big and that we should split it up.

Ok i've made some css changes to the wiki, to more closely align to Resonite's color scheme, Chroma will probably tell me to change them later

2024-01-13

I've enabled: ShortDescription which allows you to give each page a short description, these have the ability to show up in search results within the skin that we're using.

A new writing guideline:

  • Avoid using "Click here" or "here" or "page"
    • Instead try incorporating the name of the article or link into the sentence.
    • Click here to read about bot commands => Bot commands allow you to do cool things
    • There's an article, that explains more.

There also appears to be a way to get search results to have an image, I'll find out what's going on there.

2024-01-12

Today's wiki updates:

  • Still looking at performance
  • Looking into getting more people able to apply the automoderated role
  • Working on some additional guidelines.
  • Maybe PDF if i run out of other stuff to do

Some wiki notes:

  • Please stop DM'ing me about mistakes or information that is out of date, just go edit it. Editing it takes seconds, waiting for prime to wake up takes between 6 and 14 hours depending on the day
  • Wiki_Contributions_&_Translations has full information about some writing guidelines/style/pointers, it'll continue to be updated as we decide on more advice
  • Asking questions about how to edit, or how best to format etc is fine. But for the most part just edit it.

Launch(2024-01-11)

Hey Everyone, the wiki is now open and launched.

It can be accessed at (You're reading it) .

As a reminder some items from the GH Issue: Documentation is NOT finished Anyone can edit the wiki The wiki is a community project, you can contribute. This is just the start of the wiki, big changes are due for almost every page.

While anyone can edit the wiki, your first few edits will be going through a moderation queue, this queue just prevents your edits from being "live" until they are reviewed. In 90% of cases your first edit will lead to you being cleared to work on the wiki without moderation review in the future.

You register with a normal account at the moment, Resonite account linking is Soon TM.

Please check: Wiki Status for a list of known issues and plans.

Please discuss wiki things in ⁠📖wiki , I'd encourage threads too. There's also ⁠wiki-log which lists changes to the wiki automatically. I think its cool as it builds excitement about people changing things.

Quick Update here because I forgot: I'd like to thank a bunch of Durian users who helped get this working. They know who they are.