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

Markdown rewrite using hugo #303

Merged
merged 50 commits into from
Jul 31, 2022
Merged

Markdown rewrite using hugo #303

merged 50 commits into from
Jul 31, 2022

Conversation

tbabej
Copy link
Member

@tbabej tbabej commented Dec 22, 2021

This is a rough draft. Run using

hugo server -D

@tbabej tbabej mentioned this pull request Dec 22, 2021
@djmitche
Copy link
Collaborator

djmitche commented Jan 9, 2022

I tried running hugo, and

funk ~/p/tw.org [md-rewrite*] $ ./hugo server -D
Start building sites … 
hugo v0.91.2-1798BD3F linux/amd64 BuildDate=2021-12-23T15:33:34Z VendorInfo=gohugoio
WARN 2022/01/09 17:47:42 Page.URL is deprecated and will be removed in a future release. Use .Permalink or .RelPermalink. If what you want is the front matter URL value, use .Params.url
Error: Error building site: failed to render pages: render of "home" failed: "/home/dustin/p/tw.org/themes/bootstrap/layouts/index.html:21:28": execute of template failed: template: index.html:21:28: executing "index.html" at <index ($.Site.Data.releases) 0>: error calling index: index of untyped nil
Built in 247 ms

Is there some secret sauce here to get the site data? Perhaps a README update is in order?

How can I help this along?

@tbabej
Copy link
Member Author

tbabej commented Jan 9, 2022

@djmitche Good catch! Turns out that I had to push one more file, which I considered unrelated, but was wrong. Can you try to re-run hugo server -D now?

@djmitche
Copy link
Collaborator

djmitche commented Jan 9, 2022

Much better!

@djmitche
Copy link
Collaborator

I made some README upadates here, but it appears I can't push to this branch :(

Also, I'm not sure what's done here and what's still to do ? It looks like it's got some stuff imported from timewarrior right now. How can I help here?

@lauft
Copy link
Member

lauft commented Jan 25, 2022

Hello @djmitche, sorry for the late answer.

I have updated your access rights, see if you can push to this branch now.

The Timewarrior stuff is obviously copy paste from ti.net, this has to be removed/adapted to the actual content of taskwarrior.org.

All in all I guess we have to go through each page and adapt the content so it is displayed correctly. As far as I have seen it, almost all top menu items are linked to the docs page (content/docs/_index.md), so let's start here.

  • Removing all clutter (::: {.navbar-header} [Toggle navigation]{.sr-only} []{.icon-ba... so we only see the bare content would be the first step.
  • Fixing the links to the other pages is easy, simply remove the .html: e.g. /docs/introduction.html ▶️ /docs/introduction
  • Do the same for every linked page...

At first, I would focus on getting the content readable. Getting the formatting right comes later.

@djmitche djmitche self-assigned this Jan 30, 2022
@djmitche
Copy link
Collaborator

@lauft thoughts on how to handle the conflicts?

@tbabej
Copy link
Member Author

tbabej commented Jan 30, 2022

The conflicts are present because this was branched off in August and some improvements were merged to the docs since then. I'll take care of it today.

@djmitche
Copy link
Collaborator

OK, I have converted everything in content/docs with reasonable formatting. There's room for improvement but since this is blocking other work I think we should go for "pretty good with issues filed".

@tbabej do you want to fix the conflicts?

@lauft do you want to review? What else will need to be done before we can turn this on?

@djmitche djmitche requested a review from lauft February 21, 2022 00:07
@lauft
Copy link
Member

lauft commented Feb 21, 2022

Thanks for your work. I will review it as soon as possible. Please be patient.

@lauft
Copy link
Member

lauft commented Apr 15, 2022

@djmitche While reviewing the changes you made, I also started adapting the remaining pages to Markdown and Hugo.
This got a bit out of hand, but in the end I am now mostly through all of the pages and have pushed those changes to this branch.

I agree with your idea to move the design documents to the Taskwarrior repository, however I moved the How To Build Taskwarrior back, as this page was also referenced from outside the 'news' section. Its content is definitely outdated (e.g. we do not work with patch submissions but pull requests), but that is something to fix later.

I would say there are only two things to do before we are ready to replace the old site:

  • Merge all changes to the site which have happend since this branch branched off
  • Rebase this branch onto master and adapt the update of tools-data.json to the way it is happening over on ti.net.

After that I think the tasks left to do are

  • 'Restore' the news section, i.e. display a short summary of each news item on the news list (currently only the title ist listed)
  • Show recent news item(s) on front page (I would reduce this to the latest one...)
  • Use Hugo shortcode to reference the lastest version on the web page, so we do not have to update all pages when a new release comes out
  • Check documentations for outdated sections and update them
  • Decide what to do with sub-pages for clog (move to GBF.org?) and taskserver (also move or keept it, as it is quite related to Timewarrior?)
  • Split FAQ into individual files (analogue to news items)

@lauft lauft force-pushed the md-rewrite branch 2 times, most recently from 0efd4d2 to ecf9e8d Compare April 18, 2022 12:56
@lauft
Copy link
Member

lauft commented Jul 31, 2022

I have ironed out the big issues from the list above. For the rest I have created tickets

@lauft lauft deleted the md-rewrite branch July 31, 2022 20:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants