Explore Moving Documentation To GitHub Pages

[ihcsim]

We should explore moving the docs site to GitHub Pages. It seems to provide better support for markdown/HTML/CSS/JS and integration with GitHub Actions. Together with Jekyll, it also offer a wide selection of themes.

[github-actions]

Thanks for opening this issue 👍. The team will review it shortly.

If this is a bug report, make sure to include clear instructions how on to reproduce the problem with minimal reproducible examples, where possible. If this is a security report, please review our security policy as outlined in SECURITY.md.

If you haven't already, please take a moment to review our project's Code of Conduct document.

[julio-lopez]

@ihcsim https://github.com/gohugoio/hugo is a good alternative for Jekyll, if not preferred.

[ihcsim]

@julio-lopez No complains about Hugo; I used it in a previous project. What does the Hugo/GH Pages integration look like? I haven't looked into it, but GH Pages mentioned Jekyll has built-in support.

[github-actions]

This issue is marked as stale due to inactivity. Add a new comment to reactivate it.

[pavannd1]

Still relevant

[Sagar2366]

@ihcsim @pavannd1 I would like to work on this issue.

[ihcsim]

@Sagar2366 Currently, all the docs are written in rst format. Any idea what porting it over to GH Pages with Hugo looks like, including CI automation etc.?

[github-actions]

This issue is marked as stale due to inactivity. Add a new comment to reactivate it.

[github-actions]

This issue is closed due to inactivity. Feel free to reopen it, if it's still relevant.

[mlavi]

Let's share this with our new Technical Writer

[mlavi]

https://github.com/kanisterio/kanister/tree/master/docs are published to S3+Cloudfront during internal Kanister release pipeline. Let's discuss refactoring build+publish docs to GitHub.

[hairyhum]

#2642 is merged. Now we need to make a GH workflow to build and publish the docs.

[mlavi]

While that is underway, I've made REQ0054258 with Veeam CT to update DNS with doc-new IN CNAME kanisterio.github.io