Jump to content

migrate from wiki to jekyll, hugo, or some other page builder


Recommended Posts

I know in theory a wiki is supposed to make it easier to maintain documentation, but I'm not sure if that's always the case.

 

Has there been any discussion on using some website builder for docs?

 

A few examples of other projects that do this:

 

Community Health Toolkit

 

Godot

 

Meson

 

Especially after 0ad has migrated to a {git/pull request}-based system so people can submit patches more efficiently, it seems that being able to review new documentation will help assure the docs are in better shape, and hopefully encourage more people to review, edit, and submit.

Edited by andy5995
Link to comment
Share on other sites

Actually there have been although it was for the main website rather than the wiki.

Some more technical documentation is on docs.wildfiregames.com. Mostly generated stuff except for the design document.

Anyway what was suggested was to replace the wordpress by a hugo generated website and include cdns for various areas of the world using Cloudflare. Given the recent news I'm glad we didn't.

The main issue was that we lose some of the simplicity offered by wordpress.

Don't get me wrong I love git as much as the next programmer but I've never found it user friendly nor convenient for managing user facing docs.

Maybe they made progress since then on the various platforms but I feel like wyswyg editors are still superior.

Some stuff could be migrated from the main website so that it can be edited more easily like build instructions and whatnot or 0 A.D's story which is now outdated too.

I'd also love to have some proper internationalization.

Also since I manage all the running applications alone save from the lobby and the forums the goal was to reduce work by putting everything on gitea rather than maintaining Phabricator and Trac.

  • Thanks 1
Link to comment
Share on other sites

  • 2 years later...
51 minutes ago, andy5995 said:

@Stan`@ItmsCan this be enabled so that pull requests from the wiki can be reviewed? And do you agree that it would be a good idea?

https://gist.githubusercontent.com/andy5995/2091495227261dc76d0f8657df78f362/raw/508ad5ee4268d51d5db26be48ec4cdd0a6312a3e/gistfile1.txt

image.thumb.png.e1b596fe5e455faf5fdb661d624c2e7c.png

I think @Itms looked into it but it's not possible ?

Link to comment
Share on other sites

On 10/10/2024 at 3:30 PM, andy5995 said:

@Stan`@ItmsCan this be enabled so that pull requests from the wiki can be reviewed? And do you agree that it would be a good idea?

https://gist.githubusercontent.com/andy5995/2091495227261dc76d0f8657df78f362/raw/508ad5ee4268d51d5db26be48ec4cdd0a6312a3e/gistfile1.txt

image.thumb.png.e1b596fe5e455faf5fdb661d624c2e7c.png

Hi andy, what is this gist? Who wrote that? I see no information anywhere about Gitea having a "wiki pull requests" feature. I agree it would be desirable.

Link to comment
Share on other sites

3 hours ago, Itms said:

Hi andy, what is this gist? Who wrote that? I see no information anywhere about Gitea having a "wiki pull requests" feature. I agree it would be desirable.

@ItmsChatGPT. That's why I had to ask if it was possible. ;) I'll be sure to mention the "author" next time I post information like that to make it more clear.

Let me know if you'd like me to set up a repo that publishes the docs like I mentioned in my original post.

Link to comment
Share on other sites

ChatGPT is a tool designed to generate text. It is not a search engine and it cannot be trusted to give correct information.

1 hour ago, andy5995 said:

Let me know if you'd like me to set up a repo that publishes the docs like I mentioned in my original post.

You can do so if you wish, but I share all of Stan's reservations expressed in the above post.

  • Like 2
Link to comment
Share on other sites

Shameless plug: https://github.com/Dunedan/ghaction-wiki-sync/tree/improvements

It's a fork of an existing Github action to sync parts of a Git repository with a Git wiki repository and works on Gitea as well. I looked into that for another purpose, but it'd work for the 0ad wiki repository as well. It'd however require using another repository as its source and doing all changes as pull requests.

As there hasn't been any response from the original author to my PR with improvements I'll soon merge my changes to the master branch of my fork and use that as a base for some stuff.

That said, personally I'd prefer a solution which would still allow the same low barrier we have for changes to the wiki right now plus the ability to propose changes via pull requests.

  • Like 2
Link to comment
Share on other sites

4 minutes ago, Dunedan said:

That said, personally I'd prefer a solution which would still allow the same low barrier we have for changes to the wiki right now plus the ability to propose changes via pull requests.

Same, the point was that anyone should be able to edit the wiki.

Link to comment
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.

 Share

×
×
  • Create New...