where and how publish the docs about cloudflow-contrib HOT 13 CLOSED

@andreaTP, the banner needs to be adjusted for the URL. Probably you either copied the supplemental-ui from the OSS Cloudflow or the commercial Akka Data Pipelines doc repos? Each of these is set to enforce cookies on it's own domain. @rasummer can point you to the location to change. Do you only plan to publish as github pages?

from cloudflow-contrib.

thanks @rstento I was planning to use GH pages if there is no objection:
https://lightbend.github.io/cloudflow-contrib

I check if I can find the domain in the banner!

from cloudflow-contrib.

@andreaTP, I have no objection to GH pages for open source doc. Cheers!

from cloudflow-contrib.

Is this a publicly promoted set of docs? I ask as it has no privacy policy links, no cookie policy or settings buttons in the footer. If it's intended for a non-public use, then maybe we can pull the cookie banner and analytics out of it. Otherwise we'll need to look at solutions, as cookie banners work based on domains.

from cloudflow-contrib.

@rasummer what you are saying is that, since it's going to be a public repository maintained by the community we don't need to set up cookie banners?

from cloudflow-contrib.

Nope, the opposite. Due to it having all the nav elements pulled out, including items such as Privacy Policy links, I was asking if this wasn't going to be public.

If it's public facing we absolutely need to have privacy policy links, cookie banner functionality working. We need to get this working on a cloudflow.io domain, just like we do the other cloudflow docs (https://cloudflow.io/docs/current/index.html) as the cookie compliance code stores a Cloudflow.io visitors cookie preferences based on that top level domain.

from cloudflow-contrib.

ok, I misinterpreted, can you help or give guidance on how to achieve that @rasummer ?

from cloudflow-contrib.

Internal IT/Support should be able to help with mapping the generated docs to a cloudflow.io/docs/... directory. I believe they do the same with all our various Lightbend commercial doc repos that point to developer.lightbend.com/docs/... etc.

Once these docs are then served from a cloudflow.io domain, the cookie banner should start working.

We will need to put the Lightbend/Cloudflow legal/privacy footer back into these docs. Assuming you removed it and should be easy to revert, if not I can help with that.

from cloudflow-contrib.

thanks for the feedback @rasummer !

In the footer there are more things than legal/privacy, do you know what should be included what can be removed? I will try to have a look tomorrow and submit PRs for your review.

I don't think we want to serve those docs through cloudflow.io domain, to reinforce the fact that this repository is "community maintained".
Can we set up the cookie banner in raw GH pages? in particular for this URL: https://lightbend.github.io/cloudflow-contrib

from cloudflow-contrib.

As long as the we have the legal footer that you've added back, we are covered from cookie/privacy perspective. It's up to you if you want to add back in menu items that link to other projects/lightbend etc.

The cookie preference popup is working now, as you are using the test script (added -test to the end of the id). The test script isn't associated with a specific domain. Basically it allows you to temporarily test with any domain, it's not meant for production. For now I think it's fine to temporally use the test script, as it does prevent cookies. But we need to figure out long term.

As for setting up a banner for lightbend.github.io. We have a contract for a specific number of domains, so I'll need to see if we can add another one. If we do add lightbend.github.io, then it would be a Lightbend branded privacy banner, as it's a Lightbend subdomain of github.io. If you want to keep everything branded Cloudflow, then we really need to move these docs over to the cloudflow.io domain.

Also for what it's worth, having these docs on the lightbend.github.io domain from my personal perspective makes it feel more corporate and less community. I associate community and open source with the cloudflow.io domain.

from cloudflow-contrib.

thanks a lot, @rasummer , for your explanation.

I forward the decisions about domains and co. to @jtownley and @RayRoestenburg .
I'll keep this issue open and change the title.

from cloudflow-contrib.

@andreaTP cloudflow.io sounds good to me, for now. We can take further distance later, if we need to.

from cloudflow-contrib.

we discussed and decided to leave those docs in the GH pages at least for now.
I close this Issue and we re-iterate when necessary.
Thanks to everyone!

from cloudflow-contrib.