Docusaurus-ify

[jolheiser]

This PR cleans up the docs in a way to make them simpler to ingest by our docs repo.

1. It includes all of the sed invocations our ingestion did, removing the need to do it at build time.
2. It replaces the shortcode variable replacement method with @variable@ style, simply for easier sed invocations when required.
3. It removes unused files and moves the docs up a level as cleanup.

Sorry if I rebase a few times in these PRs, it tends to be easier to deal with conflicts since there's a lot of file moving as well.

[delvh]

Why WIP?

[jolheiser]

Another thing to note, we no longer have an "offline build" of docs with this current PR, as there's no hugo anymore.

Does it make sense to add docusaurus scaffolding in this PR, a follow-up, or not at all?

[delvh]

follow-up?

[delvh]

Still, why is this PR WIP?

[jolheiser]

Still, why is this PR WIP?

Only until I fixed the CI piece and got a little feedback. It is otherwise ready, simply needs coordination among the three PRs because the docs repo PR will fail until they are all merged, and then that one can be merged.

Not so much WIP as it is coordinated.

[techknowlogick]

My thoughts on an offline build: I know people have found it helpful in the past so I'm hesitant to do away with it, at least fully, but I'd be resistant to including docusaurus deps into the main repo. Perhaps the offline build could remain in some minimal way of rendering the markdown to HTML?

[jolheiser]

Perhaps the offline build could remain in some minimal way of rendering the markdown to HTML?

That could be possible, what I've done in this specific PR is to just tar up the markdown files, so at least they are included.

A followup could be to convert them to HTML maybe? Or would you prefer that happen in this PR?

[techknowlogick]

A followup could be to convert them to HTML maybe? Or would you prefer that happen in this PR?

probably a followup, as this covers a lot already (thanks btw)

[techknowlogick]

Is there a matching PR for the docs repo for when this is merged?

[jolheiser]

Is there a matching PR for the docs repo for when this is merged?

Yep, https://gitea.com/gitea/gitea-docusaurus/pulls/51

[lunny]

We can have a HTML tar or PDF download link on the documentation site.

[lunny]

So this is docs source but not the docs. It's a break change from before.

[delvh]

Why is that breaking?
For whom?
People who self-host our documentation?

[jolheiser]

As I mentioned above, a follow-up could be to add some form of conversion to HTML/PDF or similar.

[denyskon]

👍

[jolheiser]

Just as a heads up, I'll resolve conflicts in one pass, but I'd like to wait for #26052 and #26053 to be approved first.
They should ideally all go in a batch along with the companion PR in the docs repo.

Then I can also clean up issues (if any) that come from these changes.

[GiteaBot]

@jolheiser please fix the merge conflicts. 🍵

[a1012112796]

Then, wonder how to view preview when edit document now？

[jolheiser]

Then, wonder how to view preview when edit document now？

This is something I will look in to, but I'd argue that previewing it in Hugo wouldn't be a good measure of how it would end up in docusaurus.

For now any markdown previewer should give a semi-accurate view until we get something better in place. 🙂