search

valkey-io / valkey-io.github.io

BSD 3-Clause "New" or "Revised" License
31 stars 25 forks source link

Use GitHub Pages for hosting #17

Closed AMoo-Miki closed 2 months ago

AMoo-Miki commented 2 months ago

Description

This change will build and deploy the website and docs to GHP. This should be followed by renaming the repository to valkey-io.github.io.

Check List

By submitting this pull request, I confirm that my contribution is made under the terms of the BSD-3-Clause License.

madolson commented 2 months ago

The OpenSearch once commented this was a bad idea because it made later redirection more difficult. I assume we'll still be able to have URLs like valkey.io/docs/commands/set or will it have to be valkey.github.io/whatever ?

Laphatize commented 2 months ago

Assuming path structure is the same in both domains, there should be no issue.

The below is possible with Github Pages: https://valkey.github.io/docs/commands/set -> https://valkey.io/docs/commands/set

More info regarding custom domains & Github Pages: https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site

AMoo-Miki commented 2 months ago

The only complication arises if we want more control or want to do things beyond the super limited ones GHP allows us to. For example, OpenSearch wanted to have different versions of their docs to be stored in different branches and built only when they had changes (because of the time cost due to its volume). GHP is okay for what we have today but if our needs evolve, we can easily move to something with more freedom.

We have the plumbing for both GHP and CloudFront solutions. While access to the plumbing on GHP can be delegated to anyone, I have no way to share access to the CloudFront plumbing (which is my main motivator for this PR).

stockholmux commented 2 months ago

@madolson The redirect strategy (although limited) is fine as long as we don't have people depending on valkey-io.github.io and the final destination is an actual URL (valkey.io).

(you probably heard me preaching that .github.io is a bad move. GitHub Pages is fine behind a domain name though)

stockholmux commented 2 months ago

Btw, great work on this @AMoo-Miki!

madolson commented 2 months ago

(you probably heard me preaching that .github.io is a bad move. GitHub Pages is fine behind a domain name though)

Sounds good. We are writing valkey.io everywhere, I just want to make sure is no concerns with using that.