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

doc: move wiki content to docsify page #5155

Merged
merged 8 commits into from
Oct 31, 2023
Merged

doc: move wiki content to docsify page #5155

merged 8 commits into from
Oct 31, 2023

Conversation

skaldarnar
Copy link
Member

@skaldarnar skaldarnar commented Oct 30, 2023

Contains

Merges the content of the Terasology wiki (from commit e4d4b10424f24eed6583ea0e998da8aa32a27a3f) into the docs/ folder and set up a docsify page for it.

How to test

The page can be previewed locally by starting a simple HTTP server from the docs/ folder, for instance by running

python -m http.server 3000

Outstanding before merging

I think this is mostly functional by now. The wiki content itself is far from perfect, and I already removed a couple of dead links.
However, I think this is a task for follow-up PRs.

  • Review to confirm this is in a somewhat usable state
  • before or after merging: configure Github to serve Github pages for the engine repo

The following tasks should be performed after merging this:

  • (after merge) delete/disable the wiki
  • (after merge) check for links to the wiki and correct them
  • (optional) merge the content from docs-pre-merge/ into docs, but probably works better in a follow-up PR
  • convert or delete .mediawiki pages

@skaldarnar skaldarnar added this to the 2023 Revive - Milestone 2 milestone Oct 30, 2023
@skaldarnar skaldarnar added the Category: Doc Requests, Issues and Changes targeting javadoc and module documentation label Oct 30, 2023
Copy link
Member

@jdrueckert jdrueckert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generally looks good, except for

  • images and links in included README.md are broken (might be due to the move of docs/images?)
  • page titles are not shown except if they're explicitly included in the page content (probably due to wiki magic taking care of that before)

@BenjaminAmos
Copy link
Contributor

I'm getting an error trying to clone this with git (on Windows):
error: invalid path 'docs/Teracon-2017:-Slides-about-multiplayer.md'

If we keep files with : in their names in the repository, then Windows users will always fail to clone it.

Problem; Most pages don't have a title in the markdown, as the wiki previously displayed the page title based on the file name.

Solution: Enable `autoHeader` to use the title from the `_sidebar.md` file on the pages itself.
@skaldarnar
Copy link
Member Author

page titles are not shown except if they're explicitly included in the page content (probably due to wiki magic taking care of that before)

@jdrueckert This should be addressed by 2a7cb52

[…] files with : in their names in the repository […]

@BenjaminAmos Addressed in 2789867

@skaldarnar
Copy link
Member Author

images and links in included README.md are broken (might be due to the move of docs/images?)

@jdrueckert Without touching the main README in this PR, I instead made the Home page of the wiki the landing page in fae7b47, so at least no broken images/links.

Copy link
Member

@jdrueckert jdrueckert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is good enough for the initial migration 👍

@jdrueckert jdrueckert merged commit 2d8ef61 into develop Oct 31, 2023
9 checks passed
@jdrueckert jdrueckert deleted the topic/docsify branch October 31, 2023 13:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Category: Doc Requests, Issues and Changes targeting javadoc and module documentation
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants