rook / rook.github.io Goto Github PK

The new rook webpage design shows codeboxes with gray background and gray font color which is hard to view. Maybe you can change to font or background to a better visible color.

Thanks

I've noticed that every time I seach something on google that has to do with rook, I always land on the v0.8 documentation page and not on the latest version.
It would be better if one could give the old versions as well as the master branch a "nodinex" meta tag, so google doesn't index those sites.
In my opinion the majority of users will always use the latest version of rook thus outweighing the users that still use v0.8.

Without borders our tables less readable. Some examples of docs that can benefit from this:

https://rook.io/docs/rook/v1.0/edgefs-vdev-management.html

E.g., old 1.8 release docs are still appearing in search engine results when searching for anything Rook related.

As part of our ongoing efforts in encouraging better developer experience across different CNCF projects, we figured it would be nice for projects to showcase their packages hosted on ArtifactHub by embedding directly on the website.

To embed all the necessary project-related packages, kindly follow this guide. You can as well view some examples:

• Keptn integration
• Keda

In the rook.io docs, the experience could be improved if each section header had anchor tags like they do on github. On github, hovering over a section header provides a little link icon to the left of the header. When clicking this icon you are given the direct link to this section.

One example is https://github.com/rook/rook/blob/master/Documentation/kubernetes.md#rook-client. See the attached screenshot.

This makes it much easier to give our users an easy direct link to the relevant documentation section to help with their problem.

Related Jekyll issue: jekyll/jekyll#2690 (comment)

As stated in the file, we should get rid of the build directory and move the preprocess.js script to root once we know that is is not depended on by old branches of https://github.com/rook/rook

The code that needs to be merged to all active branches of https://github.com/rook/rook is in rook/rook#2497

The v1.10 and v1.9 pages say that they are a development version of the docs. Let's change this to indicate that they just aren't the latest version, rather than being a "development version"
https://rook.io/docs/rook/v1.10/Getting-Started/intro/

We should replace the gitter icon and link with slack:

<script async defer src="https://slack.yourdomain.com/slackin.js"></script>
<!-- append "?" to the URL for the large version -->

See https://github.com/rauchg/slackin#badges

our domain is https://rook-slackin.herokuapp.com so it might be:

<script async defer src="https://rook-slackin.herokuapp.com/slackin.js"></script>
<!-- append "?" to the URL for the large version -->

Hello,

I've followed this instruction to teardown my rook cluster but it stuck when I try to run the below command:

root@tb:/home/xxx/rook/cluster/examples/kubernetes/ceph# kubectl delete -n rook-ceph cephblockpool replicapool
cephblockpool.ceph.rook.io "replicapool" deleted

I waited like 24 hours to complete it but, no luck.
Thank you

We should add the CNCF logo and the following text:

"Rook is an inception level project of the CNCF"

to the rook.io website. Similar to https://www.envoyproxy.io/

The "Features of Rook" part of rook.io looks broken on Chrome. Firefox, however, is fine.

Screenshots:

• Chrome 75.0.3770.90 (Official Build) (64-bit): https://i.imgur.com/XBGoz1p.jpg
• Firefox 67.0.2 (64-bit): https://i.imgur.com/S3gkmT5.jpg

@rathpc

Hi,
Described at README there's a mention to generation via GHPages. In other projects we can see either their own CI/CD doing the builds or allowing 'travis-ci.org' 'free tier' to build and test and other services like netlify to 'render' the PR 'live'

For example: PR: Pelican-Elegant/elegant#448
'Rendered' preview: https://deploy-preview-448--pelicanelegant.netlify.com/

Travis build: https://travis-ci.org/Pelican-Elegant/elegant/builds/559242879?utm_source=github_status&utm_medium=notification

Go to the Rook docs and try to change versions of the documentation. Nothing happens when you change the version in the combobox on the bottom of the page. You have to type the URL for another version.