Integrate website redesign: `david-allison/ankidroid-website`

[david-allison]

We have a production-ready landing page (and planned site) located at: https://github.com/david-allison/ankidroid-website

This issue tracks tasks which are required before we go live.

Decisions

• This repo will be the source of truth for publishing to https://ankidroid.org, containing data currently in ankidroid-website
• The manual will be served by https://docs.ankidroid.org
• Merge into this repo. Do not use git subtree

Current state

• Both https://docs.ankidroid.org and https://ankidroid.org serve the manual. https://docs.ankidroid.org is a CNAME to https://ankidroid.org
• This repo is deployed via https://github.com/ankidroid/ankidroiddocs/blob/main/.github/workflows/publish.yml
  • docs are located at ankidroid@ankidroid.org:/usr/share/nginx/html/
• The website repo handles existing # redirects

Tasks

• Evaluate options for merging repo:ankidroid-website into repo:ankidroiddocs
  • merge the repo in 🏗️
  • ideally in a ankidroid.org folder in this repo 🏗️
  • move ankidroid-website CI to ankidroiddocs 🏗️
  • Consider issues/PR discussions and linkage to the old repo
    • we could also rebase commits to cross-link the repo/PRs
• Update CI to deploy a new folder/webroot (without nginx hosting it inside /usr/share/nginx/html/)
  • ensure index.html is handled for both webroots.
  • rethink /usr/share/nginx/html/ usage; /var/www/docs.ankidroid.org/ would likely be better
• Update nginx
  • we could potentially do with nginx documentation in this repo - syncing this between the live site may be an issue
  • fix redirects: help.html/changelog.html etc... need to be handled from the root

Follow-ups

• Determine if we rename this repo

[mikehardy]

I'd prefer to avoid subtrees or submodules or anything, I'd prefer just to have a single repo that was focused on web presence if at all possible with just actual directories in the repo - more like a monorepo setup maybe?

less repos is more, basically

so, refactor current "ankidroiddocs" repo to have a "docs" subdir with existing, and make it work as a non-functional structural change?

then add a "homepage" (or, if we name the "monorepo"-style directories by their URL target "webroot" or something, or maybe be explicit with target in name, like "docs.ankidroid.org" and just "ankidroid.org" ?)

naming not super important, single-repo and different sub-directories for different published targets is the thought

Why not have nginx host everything ?
Not sure what the DNS effect is - docs and '.' are both on the cert for SSL (as is www) so nginx should be able to do use the cert for both contemplated content sites it's serving ?

[david-allison]

I haven't used subtree and I'd like to take a look. I suspect you're right and a bare merge is the right call. I've updated the above post to state that I want to archive ankidroid-website, as this was unclear.

EDIT: yeah... I'm not using subtrees

---

so, refactor current "ankidroiddocs" repo to have a "docs" subdir with existing, and make it work as a non-functional structural change?

Yep

then add a "homepage" (or, if we name the "monorepo"-style directories by their URL target "webroot" or something, or maybe be explicit with target in name, like "docs.ankidroid.org" and just "ankidroid.org" ?)

/www/, /site/ or /landing was preferred before reading this comment.

/ankidroid.org would be awesome! I'm mildly concerned about . in a folder name, I believe it's safe unless it's at the start or end, but I'm not an expert here.

/webroot doesn't read well to me. /homepage is one page, and this will be a micro-site.

Why not have nginx host everything ?
Not sure what the DNS effect is - docs and '.' are both on the cert for SSL (as is www) so nginx should be able to do use the cert for both contemplated content sites it's serving ?

We should! [edited the OP to be more clear] I'm used to having nginx hosting everything. You can serve multiple subdomains + webroots with the same cert

/usr/share/nginx/html/ reads as unusual to me, I'm used to serving from /var/www, so the ankidroid.org and docs.ankidroid.org are siblings in www.

The /usr/share hierarchy is for all read-only architecture independent data files

https://refspecs.linuxfoundation.org/FHS_3.0/fhs/ch04s11.html

example:

Wants a bit of tweaking for our needs - HTTPS redirects; certbot config to either handle a wildcard or the specific domains] but this would work

# /etc/nginx/sites-available/archive-example-com.conf
server {
    root /var/www/archive;
    index index.html;
    server_name archive.example.com;

    listen 80;
    listen 443 ssl; # managed by Certbot

    ssl_certificate /etc/letsencrypt/live/example.com/fullchain.pem; # managed by Certbot
    ssl_certificate_key /etc/letsencrypt/live/example.com/privkey.pem; # managed by Certbot
    include /etc/letsencrypt/options-ssl-nginx.conf; # managed by Certbot
    ssl_dhparam /etc/letsencrypt/ssl-dhparams.pem; # managed by Certbot
}

[mikehardy]

I'm fine with moving stuff wherever on the filesystem, I just went where the original static "you installed nginx! here's a biscuit!" default page was, which I guess is considered a valid /usr/share thing from a packagers perspective, I dunno - was rebuilding under time pressure after the security breach toasted the prior droplet

basically, anything works, all good by me

I'm also not super fussed about the naming, I want the fewest hurdles possible to get this live. I personally don't feel a . is risky in the name, this is a unix CI runner deploying to a unix server. They don't care