search

kanisterio / kanister

An extensible framework for application-level data management on Kubernetes
https://kanister.io
Apache License 2.0
735 stars 148 forks source link

Explore Moving Documentation To GitHub Pages #1436

Open ihcsim opened 2 years ago

ihcsim commented 2 years ago

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[bot] commented 2 years ago

Thanks for opening this issue :+1:. 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 commented 2 years ago

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

ihcsim commented 2 years ago

@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[bot] commented 1 year ago

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

pavannd1 commented 1 year ago

Still relevant

Sagar2366 commented 1 year ago

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

ihcsim commented 1 year ago

@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[bot] commented 1 year ago

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

github-actions[bot] commented 1 year ago

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

mlavi commented 1 year ago

Let's share this with our new Technical Writer

mlavi commented 1 year ago

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 commented 4 months ago

https://github.com/kanisterio/kanister/pull/2642 is merged. Now we need to make a GH workflow to build and publish the docs.

mlavi commented 1 month ago

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