-
Notifications
You must be signed in to change notification settings - Fork 3
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
Convert the Trac wiki to ReadTheDocs #2
base: master
Are you sure you want to change the base?
Conversation
It looks like someone put a lot of work into converting the Wiki into a cleaner and easier-to-manage form. I am sympathetic with Markdown or ReadTheDocs (even though I never used the latter and have zero experience with it). Before accepting such a huge PR it would be nice to see the actual result somewhere. Can you please provide a link to an already processed clone of the Freetz wiki in ReadTheDocs format, so we can see what it would look like? I saw an older version of it, but back then you (or whoever was the author of the comment I read) said that the conversion is not finished, many things are missing. I don't remember for instance what was said about inline images and attachments, links between articles etc. So let's see what we got here. :-) |
You can test the result on https://archive.kaidan.im/freetz.github.io/ now. Please note that this is not a location were I can keep it for long, so I'll remove it in a few weeks again. |
One last thing left is probably removing the old indexes from the pages. They wouldn't be properly updated anymore. |
I think everything is working now. Please test the result on https://archive.kaidan.im/freetz.github.io/index.html. |
Okay, I think now it's really ready :) I also tested deployment, and it works now. |
I think this PR needs a rework. I see no pictures, on the packages page tables are broken and e.g. the Rudi-Shell page has sub-pages which I cannot find in your wiki. A few links to compare: https://freetz.github.io/wiki/packages.html https://freetz.github.io/wiki/packages/rudi-shell.html I am not an active developer and don't want to make a decision pro/con merge, but my impression is that this PR is unfinished and should not (yet) be merged. |
I think images are broken because I didn't deploy the result to the root of the webserver. Some other tables work, did the packages table use another syntax maybe? |
The packages table is simply too large for pandoc. If I delete random parts of it it is converted properly. Will look into some kind of workaround later. |
reStructuredText is much easier to edit than the html pages generated by Trac.
The documentation can be built on travis-ci, and then deployed to the GitHub page.
For this to work, the owner of the freetz organization and this repository has to activate it on travis-ci.org and generate and add a GITHUB_TOKEN. More about this can be found here: https://docs.travis-ci.com/user/deployment/pages/#setting-the-github-token
Although the extracted content is already included in this repository, it can be extracted again from the html dump with
python3 extract-content.py
.With
make html
the finished documentation can be created from the reStructuredText files.After this is merged, the original html pages should not be edited again, and either be deleted or kept for historical purpose (For example if we find a better extraction method later on).