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

Migrating to Hugo #13

Merged
merged 128 commits into from
Jun 19, 2022
Merged

Migrating to Hugo #13

merged 128 commits into from
Jun 19, 2022

Conversation

inkydragon
Copy link
Contributor

@inkydragon inkydragon commented Jun 10, 2021

https://aeg-dev.github.io/AegiSite/

  • remove all ruby things
  • init hugo + doks theme (MIT License)
  • add i18n support

TODO

  • add screenshots to somewhere
  • fix old ruby template ({::template) in docs
  • generate som pages: downloads/changelog/, docs/3.2/commands/
  • Migrating old blog?
  • Migrating chinese site: https://aegi.vmoe.info/

xref: #11

Merge remote-tracking branch 'hugo/master' into switch2hugo

merge inky's fork: Aeg-dev/AegSite-hugo@a09bb1b

original theme: https://github.com/h-enk/doks
re
```
\[\[img/([^ \.]+)\.(png|jpg)\]\]
![$1](/img/3.2/$1.$2)
```
```re
\[\[([^\[\]]+)(\s+)?\n(\s+)?
[[$1
```
```re
\[\[([^\|:\.#/\[\]]+)\]\]
[$1]({{< relref "$1" >}})
```
+ "Typesetting_Tutorial" => "Visual_Typesetting"
+ replace space in links
+ remove empty link
```re
\[\[(.[^`\\]+)\|([^ ]+)\]\]
[$1]({{< relref "$2" >}})
```
Makdown was formatted with mdformat https://github.com/executablebooks/mdformat

In addition the following plugins were used:
mdformat-frontmatter
mdformat-tables
mdformat-deflist
A build of the site before and after 5770dfe was compared with diff. All resulting unwanted differences were undone.

Some additional changes were also made:
 - Added plaintext as language on ass code blocks
 - Fixed nested Description List
 - Removed bolding from description list heading (as it's done in css)
 - Minor formatting fixes along the way
@CoffeeFlux
Copy link
Member

@inkydragon any chance you can take a look at @seproDev's work? If not, I'll spin up a new branch and review it all as a whole.

@inkydragon
Copy link
Contributor Author

@CoffeeFlux I'll take a look this weekend. A quick check looks good.
After a local compile, and if everything works, I'll merge pr#55.

seproDev and others added 3 commits March 18, 2022 12:35
Windows file/folder names can not end in dots, but hugo doesn't take this in to account.
@inkydragon
Copy link
Contributor Author

@CoffeeFlux Ready for review.

@TheOneric
Copy link

TheOneric commented Mar 18, 2022

Thanks for your efforts inkydragon and seproDev!
A couple of small remarks from mostly just randomly browsing through the preview site at https://aeg-dev.github.io/AegiSite/.

  • Most things appear pretty solid and certainly much better than having nothing up at all :)
  • In the 3.2 docs, if the Browser windows i too narrow, the section list is collapsed and hidden at the top of the page. But because theres no text, just a button with two downwards-pointing arrowheads (i.e. similar to << but rotated by -90°) I completly missed it at first and couldn't find the ASS-Tags section. Imho having some text next to the button to make it stand out more would be a good idea.
  • On the topic of the section list, I'd personally prefer if by default when no javascript is active, it would be fully expanded to make the docs usable without js enabled as a nice to have.
  • Firefox’ accesibility tester has a few complaints, but they appear easy to fix
    • The elements in the top-right menu are not labeled. See here for full explanation, in short they should have an associated <label> or if not possible use an aria-label="" attribute.
    • The contrast on the 3.0 Manual button in darkmode is too low
  • At the home page, under the Get started button it states to use “Open-source BSD-style license”. This isn't outright wrong, but also not fully corrrect or consistent.
    In summary I think referring to it as “mostly BSD-style, but in total GPL2 and compatible” or similar is more correct. Details below, though I did not do a full, throughout license audit.
    • The main licence is indeed a BSD-3clause license and the BSDL and MIT listed in the main repo’s LICENSE are also BSD-style.
    • I'm not sure if MPL counts as BSD-style.
    • Even ignoring additionally linked in libraries from outside the main repo, there’s also (L)GPL licensed source code in a typical Aegisub build.
      • In subprojects/
        • libiconv is LGPL
        • csri (which afaict isn't an external project despite its placement) has several GPL-2.0+ files.
        • The sources for the above are both included in the tarballs provided on the site and they are also included in the builds.
      • For the sake of completeness, in src/
        • avisynth.h is GPL-2.0+ but contains a special exception if only the interfaces from avisynth.h are used so this can be probably ignored.
    • E.g. the installer refers to Aegisub as a whole as “GPL 2” presumably because of the above, so this is inconsistent
    • This also meens that the README in the main repo is wrong to claim “All files in this repository are licensed under various GPL-compatible BSD-style licenses”, since csri and libiconv are evidently not. (@CoffeeFlux)

@seproDev
Copy link
Contributor

seproDev commented Mar 18, 2022

Thank you for taking a look at the site. I have addressed your comments (other than the license one) in this branch. This could be merged in to the Aeg-dev:switch2hugo branch now and become part of this PR. Though Instead, since there will always be more small things to improve, I would rather get this merged first and then start having everone contribute to the main repo.

.github/dependabot.yml Outdated Show resolved Hide resolved
Comment on lines +42 to +43
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
Copy link
Member

Choose a reason for hiding this comment

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

I guess I'll need to go replace this with something that deploys to the main site? I can probably deploy to aegisub.github.io as well automatically.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

LICENSE Outdated Show resolved Hide resolved
@@ -0,0 +1,2 @@
baseurl: 'https://aegisub.github.io/aegisite/'
Copy link
Member

Choose a reason for hiding this comment

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

Does this need to be changed if I want to primary deploy target to be aegisub.org?

Copy link
Contributor

Choose a reason for hiding this comment

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

We can probably just turn canonifyURLs off and remove the baseurl.
This seemes to be the old default from doks which has since been changed.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

But if you want to deploy this site to github pages, you should set baseurl. Otherwise, baseurl will be https://aegisub.github.io, which lead all links to be 404.

Copy link
Contributor

@seproDev seproDev Apr 3, 2022

Choose a reason for hiding this comment

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

Right Github Pages will only host on https://<organization>.github.io if the repo is named <organization>.github.io, otherwise it will host on https://<organization>.github.io/<repo-name>.

I talked with CoffeeFlux on Discord and he wants to host the aegisub.org site on his own server instead of Github infrastructure, but would be fine with having Github Pages up as a backup.

I guess we could add two build enviroments with seperate config files and npm run scripts (--environment github) to deploy both to Github Pages with canonicalized URLs and to CoffeeFlux' server without.
The alternative would be dropping Github Pages entirely.

Choose a reason for hiding this comment

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

The advantage of hosting via Github Pages is that it can be managed from the repository alone, including automatic builds on new commits to master and it's generally very resilient since the hosting is external. I don't see a particular reason for not using Github Pages as the primary website if it's already half-supported.

@CoffeeFlux CoffeeFlux merged commit c7d1965 into Aegisub:master Jun 19, 2022
@seproDev seproDev mentioned this pull request Jun 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants