[jira] [Commented] (CASSANDRA-13915) Create a Docker container to build the docs
[ https://issues.apache.org/jira/browse/CASSANDRA-13915?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16277578#comment-16277578 ] ASF GitHub Bot commented on CASSANDRA-13915: Github user asfgit closed the pull request at: https://github.com/apache/cassandra/pull/154 > Create a Docker container to build the docs > --- > > Key: CASSANDRA-13915 > URL: https://issues.apache.org/jira/browse/CASSANDRA-13915 > Project: Cassandra > Issue Type: Improvement >Reporter: Joaquin Casares >Assignee: Joaquin Casares > > As requested by [~rustyrazorblade], I will be adding a Docker container to > build the docs without any prereqs (other than Docker). -- This message was sent by Atlassian JIRA (v6.4.14#64029) - To unsubscribe, e-mail: commits-unsubscr...@cassandra.apache.org For additional commands, e-mail: commits-h...@cassandra.apache.org
[jira] [Commented] (CASSANDRA-13915) Create a Docker container to build the docs
[ https://issues.apache.org/jira/browse/CASSANDRA-13915?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16277570#comment-16277570 ] Jason Brown commented on CASSANDRA-13915: - wfm. Ship it, [~rustyrazorblade]. > Create a Docker container to build the docs > --- > > Key: CASSANDRA-13915 > URL: https://issues.apache.org/jira/browse/CASSANDRA-13915 > Project: Cassandra > Issue Type: Improvement >Reporter: Joaquin Casares >Assignee: Joaquin Casares > > As requested by [~rustyrazorblade], I will be adding a Docker container to > build the docs without any prereqs (other than Docker). -- This message was sent by Atlassian JIRA (v6.4.14#64029) - To unsubscribe, e-mail: commits-unsubscr...@cassandra.apache.org For additional commands, e-mail: commits-h...@cassandra.apache.org
[jira] [Commented] (CASSANDRA-13915) Create a Docker container to build the docs
[ https://issues.apache.org/jira/browse/CASSANDRA-13915?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16277530#comment-16277530 ] Nate McCall commented on CASSANDRA-13915: - I'm inclined to get this in the water and see what sort of issues people have going forward then iterating. [~rustyrazorblade] LGTM. > Create a Docker container to build the docs > --- > > Key: CASSANDRA-13915 > URL: https://issues.apache.org/jira/browse/CASSANDRA-13915 > Project: Cassandra > Issue Type: Improvement >Reporter: Joaquin Casares >Assignee: Joaquin Casares > > As requested by [~rustyrazorblade], I will be adding a Docker container to > build the docs without any prereqs (other than Docker). -- This message was sent by Atlassian JIRA (v6.4.14#64029) - To unsubscribe, e-mail: commits-unsubscr...@cassandra.apache.org For additional commands, e-mail: commits-h...@cassandra.apache.org
[jira] [Commented] (CASSANDRA-13915) Create a Docker container to build the docs
[ https://issues.apache.org/jira/browse/CASSANDRA-13915?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16277441#comment-16277441 ] Jon Haddad commented on CASSANDRA-13915: Tossed my fixed up version to a branch, located here: https://github.com/apache/cassandra/compare/trunk...rustyrazorblade:CASSANDRA-13915-jon Any objections? > Create a Docker container to build the docs > --- > > Key: CASSANDRA-13915 > URL: https://issues.apache.org/jira/browse/CASSANDRA-13915 > Project: Cassandra > Issue Type: Improvement >Reporter: Joaquin Casares >Assignee: Joaquin Casares > > As requested by [~rustyrazorblade], I will be adding a Docker container to > build the docs without any prereqs (other than Docker). -- This message was sent by Atlassian JIRA (v6.4.14#64029) - To unsubscribe, e-mail: commits-unsubscr...@cassandra.apache.org For additional commands, e-mail: commits-h...@cassandra.apache.org
[jira] [Commented] (CASSANDRA-13915) Create a Docker container to build the docs
[ https://issues.apache.org/jira/browse/CASSANDRA-13915?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16275085#comment-16275085 ] Jon Haddad commented on CASSANDRA-13915: If you don't have an issue with it, I'm inclined to merge it in. The patch doesn't apply to trunk cleanly, so I'm going to fix it up and merge it in after a local test, unless there's an objection from [~jasobrown] (or anyone else) > Create a Docker container to build the docs > --- > > Key: CASSANDRA-13915 > URL: https://issues.apache.org/jira/browse/CASSANDRA-13915 > Project: Cassandra > Issue Type: Improvement >Reporter: Joaquin Casares >Assignee: Joaquin Casares > > As requested by [~rustyrazorblade], I will be adding a Docker container to > build the docs without any prereqs (other than Docker). -- This message was sent by Atlassian JIRA (v6.4.14#64029) - To unsubscribe, e-mail: commits-unsubscr...@cassandra.apache.org For additional commands, e-mail: commits-h...@cassandra.apache.org
[jira] [Commented] (CASSANDRA-13915) Create a Docker container to build the docs
[ https://issues.apache.org/jira/browse/CASSANDRA-13915?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16275080#comment-16275080 ] Michael Shuler commented on CASSANDRA-13915: Yeah, I just checked and the files copied out of the container by the docker RPM/deb builds are owned by my local linux system user. No sudo needed to clean. My local linux system user *is* in the {{docker}} unix group, so perhaps that's a simple fix? I run docker as my normal user and have not had any issues. https://github.com/apache/cassandra-builds/tree/master/docker > Create a Docker container to build the docs > --- > > Key: CASSANDRA-13915 > URL: https://issues.apache.org/jira/browse/CASSANDRA-13915 > Project: Cassandra > Issue Type: Improvement >Reporter: Joaquin Casares >Assignee: Joaquin Casares > > As requested by [~rustyrazorblade], I will be adding a Docker container to > build the docs without any prereqs (other than Docker). -- This message was sent by Atlassian JIRA (v6.4.14#64029) - To unsubscribe, e-mail: commits-unsubscr...@cassandra.apache.org For additional commands, e-mail: commits-h...@cassandra.apache.org
[jira] [Commented] (CASSANDRA-13915) Create a Docker container to build the docs
[ https://issues.apache.org/jira/browse/CASSANDRA-13915?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16275070#comment-16275070 ] Michael Shuler commented on CASSANDRA-13915: Sorry I missed that earlier comment. In CI, the {{jenkins}} user has no sudo access for good reason, so {{sudo $anything}} will fail. Docker is available on the Jenkins slaves, and I tested out I could start containers in jobs. I think the RPM and deb package containers don't have the root ownership issues described. I haven't tested this container out, but if there's a permissions issue on an output directory, perhaps there is a docker way to set user to run as, skipping all the root owned file problems? > Create a Docker container to build the docs > --- > > Key: CASSANDRA-13915 > URL: https://issues.apache.org/jira/browse/CASSANDRA-13915 > Project: Cassandra > Issue Type: Improvement >Reporter: Joaquin Casares >Assignee: Joaquin Casares > > As requested by [~rustyrazorblade], I will be adding a Docker container to > build the docs without any prereqs (other than Docker). -- This message was sent by Atlassian JIRA (v6.4.14#64029) - To unsubscribe, e-mail: commits-unsubscr...@cassandra.apache.org For additional commands, e-mail: commits-h...@cassandra.apache.org
[jira] [Commented] (CASSANDRA-13915) Create a Docker container to build the docs
[ https://issues.apache.org/jira/browse/CASSANDRA-13915?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16275010#comment-16275010 ] Jason Brown commented on CASSANDRA-13915: - bump [~mshuler]. Please see my earlier question about the linux file permissions > Create a Docker container to build the docs > --- > > Key: CASSANDRA-13915 > URL: https://issues.apache.org/jira/browse/CASSANDRA-13915 > Project: Cassandra > Issue Type: Improvement >Reporter: Joaquin Casares >Assignee: Joaquin Casares > > As requested by [~rustyrazorblade], I will be adding a Docker container to > build the docs without any prereqs (other than Docker). -- This message was sent by Atlassian JIRA (v6.4.14#64029) - To unsubscribe, e-mail: commits-unsubscr...@cassandra.apache.org For additional commands, e-mail: commits-h...@cassandra.apache.org
[jira] [Commented] (CASSANDRA-13915) Create a Docker container to build the docs
[ https://issues.apache.org/jira/browse/CASSANDRA-13915?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16274960#comment-16274960 ] Jon Haddad commented on CASSANDRA-13915: Regarding the file permission problem, my guess is docker is running on linux as root and on mac as your current user. > Create a Docker container to build the docs > --- > > Key: CASSANDRA-13915 > URL: https://issues.apache.org/jira/browse/CASSANDRA-13915 > Project: Cassandra > Issue Type: Improvement >Reporter: Joaquin Casares >Assignee: Joaquin Casares > > As requested by [~rustyrazorblade], I will be adding a Docker container to > build the docs without any prereqs (other than Docker). -- This message was sent by Atlassian JIRA (v6.4.14#64029) - To unsubscribe, e-mail: commits-unsubscr...@cassandra.apache.org For additional commands, e-mail: commits-h...@cassandra.apache.org
[jira] [Commented] (CASSANDRA-13915) Create a Docker container to build the docs
[ https://issues.apache.org/jira/browse/CASSANDRA-13915?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16274956#comment-16274956 ] Jon Haddad commented on CASSANDRA-13915: [~muru], I agree we should be pinning the sphinx dependencies with requirements.txt. > Create a Docker container to build the docs > --- > > Key: CASSANDRA-13915 > URL: https://issues.apache.org/jira/browse/CASSANDRA-13915 > Project: Cassandra > Issue Type: Improvement >Reporter: Joaquin Casares >Assignee: Joaquin Casares > > As requested by [~rustyrazorblade], I will be adding a Docker container to > build the docs without any prereqs (other than Docker). -- This message was sent by Atlassian JIRA (v6.4.14#64029) - To unsubscribe, e-mail: commits-unsubscr...@cassandra.apache.org For additional commands, e-mail: commits-h...@cassandra.apache.org
[jira] [Commented] (CASSANDRA-13915) Create a Docker container to build the docs
[ https://issues.apache.org/jira/browse/CASSANDRA-13915?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16240034#comment-16240034 ] Murukesh Mohanan commented on CASSANDRA-13915: -- Since the intention here is to ensure dependencies are easily handled, should we ask for specific versions when doing {{pip install sphinx sphinx_rtd_theme}} ({{requirements.txt}}-style, perhaps)? I thought of installing both of these using {{apt-get}} - {{apt-get install python-sphinx python-sphinx-rtd-theme}}, but the {{python:2.7}} Docker image is based on Debian jessie, where the [sphinx packages|https://packages.debian.org/jessie/python-sphinx] seem to be pretty old (1.2.3 vs ~1.6 now). > Create a Docker container to build the docs > --- > > Key: CASSANDRA-13915 > URL: https://issues.apache.org/jira/browse/CASSANDRA-13915 > Project: Cassandra > Issue Type: Improvement >Reporter: Joaquin Casares >Assignee: Joaquin Casares > > As requested by [~rustyrazorblade], I will be adding a Docker container to > build the docs without any prereqs (other than Docker). -- This message was sent by Atlassian JIRA (v6.4.14#64029) - To unsubscribe, e-mail: commits-unsubscr...@cassandra.apache.org For additional commands, e-mail: commits-h...@cassandra.apache.org
[jira] [Commented] (CASSANDRA-13915) Create a Docker container to build the docs
[ https://issues.apache.org/jira/browse/CASSANDRA-13915?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16240026#comment-16240026 ] Murukesh Mohanan commented on CASSANDRA-13915: -- {quote}Is there a linux alternative? Is it even possible to identify the host OS? I'd be fine with spitting out the open command on mac and a backup "open build/html/index.html file in your browser to view the docs" message if we don't know it's mac. Otherwise the backup message all the time works for me.{quote} On Linux, [{{xdg-open}}|https://portland.freedesktop.org/doc/xdg-open.html] can be a safe DE-independent alternative (it wraps around DE-specific {{gnome-open}}/{{gvfs-open}}, {{kde-open}}, etc.). I've never heard of {{exe-open}} before. It doesn't seem to be a command [available from any Ubuntu package|https://packages.ubuntu.com/search?suite=xenial=any=exactfilename=contents=exe-open], and Googling does not throw anything obvious, so I'm not sure what that is. > Create a Docker container to build the docs > --- > > Key: CASSANDRA-13915 > URL: https://issues.apache.org/jira/browse/CASSANDRA-13915 > Project: Cassandra > Issue Type: Improvement >Reporter: Joaquin Casares >Assignee: Joaquin Casares > > As requested by [~rustyrazorblade], I will be adding a Docker container to > build the docs without any prereqs (other than Docker). -- This message was sent by Atlassian JIRA (v6.4.14#64029) - To unsubscribe, e-mail: commits-unsubscr...@cassandra.apache.org For additional commands, e-mail: commits-h...@cassandra.apache.org
[jira] [Commented] (CASSANDRA-13915) Create a Docker container to build the docs
[ https://issues.apache.org/jira/browse/CASSANDRA-13915?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16209247#comment-16209247 ] Jason Brown commented on CASSANDRA-13915: - [~rustyrazorblade] I thought you were going to investigate some stuff, as [~j.casares] said: bq. As far as Mac vs Linux differences, I'll leave that to Jon Haddad to debug and send me anything he finds, if you wouldn't mind? If it's a permissions issue, send me to the file you're having issues with and I'll make necessary Docker changes since I'm on OSX right now. Other than permissions issues, I've never seen a difference between OSX and Linux containers and the container is currently running as the root user, so there shouldn't be any issues that I can think of. wrt the {{sudo ant realclean}}, it's kind of a PITA, but not insurmountable. [~mshuler] Will those linux file permissions (that I mention) be a problem for the build system(s)? > Create a Docker container to build the docs > --- > > Key: CASSANDRA-13915 > URL: https://issues.apache.org/jira/browse/CASSANDRA-13915 > Project: Cassandra > Issue Type: Improvement >Reporter: Joaquin Casares >Assignee: Joaquin Casares > > As requested by [~rustyrazorblade], I will be adding a Docker container to > build the docs without any prereqs (other than Docker). -- This message was sent by Atlassian JIRA (v6.4.14#64029) - To unsubscribe, e-mail: commits-unsubscr...@cassandra.apache.org For additional commands, e-mail: commits-h...@cassandra.apache.org
[jira] [Commented] (CASSANDRA-13915) Create a Docker container to build the docs
[ https://issues.apache.org/jira/browse/CASSANDRA-13915?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16209204#comment-16209204 ] Jon Haddad commented on CASSANDRA-13915: [~jasobrown] did you still want to handle the review? > Create a Docker container to build the docs > --- > > Key: CASSANDRA-13915 > URL: https://issues.apache.org/jira/browse/CASSANDRA-13915 > Project: Cassandra > Issue Type: Improvement >Reporter: Joaquin Casares >Assignee: Joaquin Casares > > As requested by [~rustyrazorblade], I will be adding a Docker container to > build the docs without any prereqs (other than Docker). -- This message was sent by Atlassian JIRA (v6.4.14#64029) - To unsubscribe, e-mail: commits-unsubscr...@cassandra.apache.org For additional commands, e-mail: commits-h...@cassandra.apache.org
[jira] [Commented] (CASSANDRA-13915) Create a Docker container to build the docs
[ https://issues.apache.org/jira/browse/CASSANDRA-13915?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16191768#comment-16191768 ] Joaquin Casares commented on CASSANDRA-13915: - Nice, thanks for confirming on {{ant realclean}} cleaning the docs directory. I thought it was weird that it wasn't already there. I've removed the {{open}} keyword since it was definitely only for OS-X. {{exe-open}} works on my Linux machine, fwiw. I haven't had great success getting the container to run as the local user's PID. For OSX, they do a great job with in-container permissions, most times. For Linux I always have to do a little dance, but rarely have had to implement something to make the container's data accessible to the host user. Most times I have to make the container's user be able to access the host's data. As far as Mac vs Linux differences, I'll leave that to [~rustyrazorblade] to debug and send me anything he finds, if you wouldn't mind? If it's a permissions issue, send me to the file you're having issues with and I'll make necessary Docker changes since I'm on OSX right now. Other than permissions issues, I've never seen a difference between OSX and Linux containers and the container is currently running as the {{root}} user, so there shouldn't be any issues that I can think of. As far as resolving the Linux permissions issues, won't a {{sudo ant realclean}} work for you [~jasobrown]? If not, I'll have to dig deeper to see if it's even possible to mount the volume and have the container's user match the host user's PID. > Create a Docker container to build the docs > --- > > Key: CASSANDRA-13915 > URL: https://issues.apache.org/jira/browse/CASSANDRA-13915 > Project: Cassandra > Issue Type: Improvement >Reporter: Joaquin Casares >Assignee: Joaquin Casares > > As requested by [~rustyrazorblade], I will be adding a Docker container to > build the docs without any prereqs (other than Docker). -- This message was sent by Atlassian JIRA (v6.4.14#64029) - To unsubscribe, e-mail: commits-unsubscr...@cassandra.apache.org For additional commands, e-mail: commits-h...@cassandra.apache.org
[jira] [Commented] (CASSANDRA-13915) Create a Docker container to build the docs
[ https://issues.apache.org/jira/browse/CASSANDRA-13915?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16191652#comment-16191652 ] Jason Brown commented on CASSANDRA-13915: - bq. Otherwise the backup message all the time works for me Let's keep things simple and print the 'backup' message. Anyone in the know on Mac can do other, clever things. > Create a Docker container to build the docs > --- > > Key: CASSANDRA-13915 > URL: https://issues.apache.org/jira/browse/CASSANDRA-13915 > Project: Cassandra > Issue Type: Improvement >Reporter: Joaquin Casares >Assignee: Joaquin Casares > > As requested by [~rustyrazorblade], I will be adding a Docker container to > build the docs without any prereqs (other than Docker). -- This message was sent by Atlassian JIRA (v6.4.14#64029) - To unsubscribe, e-mail: commits-unsubscr...@cassandra.apache.org For additional commands, e-mail: commits-h...@cassandra.apache.org
[jira] [Commented] (CASSANDRA-13915) Create a Docker container to build the docs
[ https://issues.apache.org/jira/browse/CASSANDRA-13915?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16191647#comment-16191647 ] Jason Brown commented on CASSANDRA-13915: - Also, another mac vs linux difference: the navigation on the left works on a mac, completely broken on linux. Actually, all hyperlinks are broken on linux. Can you take a look? > Create a Docker container to build the docs > --- > > Key: CASSANDRA-13915 > URL: https://issues.apache.org/jira/browse/CASSANDRA-13915 > Project: Cassandra > Issue Type: Improvement >Reporter: Joaquin Casares >Assignee: Joaquin Casares > > As requested by [~rustyrazorblade], I will be adding a Docker container to > build the docs without any prereqs (other than Docker). -- This message was sent by Atlassian JIRA (v6.4.14#64029) - To unsubscribe, e-mail: commits-unsubscr...@cassandra.apache.org For additional commands, e-mail: commits-h...@cassandra.apache.org
[jira] [Commented] (CASSANDRA-13915) Create a Docker container to build the docs
[ https://issues.apache.org/jira/browse/CASSANDRA-13915?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16191643#comment-16191643 ] Jason Brown commented on CASSANDRA-13915: - Also, fwiw, the design/look of the output html files is different that what we have currently [on the apache.org site|https://cassandra.apache.org/doc/latest/]. Was this is intentional? Is this a default? Does it matter? I don't care too much either way, just want to make sure this is a known thing. > Create a Docker container to build the docs > --- > > Key: CASSANDRA-13915 > URL: https://issues.apache.org/jira/browse/CASSANDRA-13915 > Project: Cassandra > Issue Type: Improvement >Reporter: Joaquin Casares >Assignee: Joaquin Casares > > As requested by [~rustyrazorblade], I will be adding a Docker container to > build the docs without any prereqs (other than Docker). -- This message was sent by Atlassian JIRA (v6.4.14#64029) - To unsubscribe, e-mail: commits-unsubscr...@cassandra.apache.org For additional commands, e-mail: commits-h...@cassandra.apache.org
[jira] [Commented] (CASSANDRA-13915) Create a Docker container to build the docs
[ https://issues.apache.org/jira/browse/CASSANDRA-13915?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16191639#comment-16191639 ] Jon Haddad commented on CASSANDRA-13915: > At a minimum, the realclean problem needs to be fixed as I suspect we'll > have it part of the automation for building the online docs hosted on > cassandra.apache.org Agreed, my Docker knowledge is also pretty low. Maybe the volume needs to be mounted as the current user? (just a guess) > For open, either remove the whole statement or add a note saying "mac only" > or something. Jon Haddad thoughts? Is there a linux alternative? Is it even possible to identify the host OS? I'd be fine with spitting out the open command on mac and a backup "open build/html/index.htmlfile in your browser to view the docs" message if we don't know it's mac. Otherwise the backup message all the time works for me. > Create a Docker container to build the docs > --- > > Key: CASSANDRA-13915 > URL: https://issues.apache.org/jira/browse/CASSANDRA-13915 > Project: Cassandra > Issue Type: Improvement >Reporter: Joaquin Casares >Assignee: Joaquin Casares > > As requested by [~rustyrazorblade], I will be adding a Docker container to > build the docs without any prereqs (other than Docker). -- This message was sent by Atlassian JIRA (v6.4.14#64029) - To unsubscribe, e-mail: commits-unsubscr...@cassandra.apache.org For additional commands, e-mail: commits-h...@cassandra.apache.org
[jira] [Commented] (CASSANDRA-13915) Create a Docker container to build the docs
[ https://issues.apache.org/jira/browse/CASSANDRA-13915?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16191621#comment-16191621 ] Jason Brown commented on CASSANDRA-13915: - bq. Dockerfile and docker-compose.yml are the default names for working with Docker-related projects sgtm. as stated above, I am a container noob. bq. you two fine with me adding the doc/build directory to the ant realclean? totally legit: {{realclean}} *should* clean all build artifacts. When I build the docs, there's the message at the end: {code} The locally built documentation can be found here: open build/html/index.html {code} However, when I do this on ubuntu 17.04, I get the following error: {code} $ open build/html/index.html Couldn't get a file descriptor referring to the console {code} A naive internet search reveals that {{open}} [isn't quite what we want|https://ubuntuforums.org/showthread.php?t=2124061}. How did you test this? Next error: after I build the docs a few times, on the same linux install, I run {{ant realclean}} again, which produces this error: {code} BUILD FAILED /opt/dev/cassandra/build.xml:196: Unable to delete directory /opt/dev/cassandra/build/test/lib {code} A quick look shows everything in {{/opt/dev/cassandra/build/}} is now owned by root, and I need to {{sudo rm -rf build}} to clean it up. Which, of course, leads to: {code} BUILD FAILED /opt/dev/cassandra/build.xml:207: Unable to delete file /opt/dev/cassandra/doc/build/doctrees/configuration/index.doctree {code} Once again, {{sudo rm -rf}}. Can you change the privileges of the artifacts that get generated, both in ./build and ./doc/build? UPDATE: I tried out all these commands on a Mac (High Sierra), and after installing Docker, everything was much smoother. No permissions issues for {{ant realclean}}, and {{open}} worked correctly. At a minimum, the {{realclean}} problem needs to be fixed as I suspect we'll have it part of thew automation for building the online docs hosted on cassandra.apache.org. For {{open}}, either remove the whole statement or add a note saying "mac only" or something. [~rustyrazorblade] thoughts? > Create a Docker container to build the docs > --- > > Key: CASSANDRA-13915 > URL: https://issues.apache.org/jira/browse/CASSANDRA-13915 > Project: Cassandra > Issue Type: Improvement >Reporter: Joaquin Casares >Assignee: Joaquin Casares > > As requested by [~rustyrazorblade], I will be adding a Docker container to > build the docs without any prereqs (other than Docker). -- This message was sent by Atlassian JIRA (v6.4.14#64029) - To unsubscribe, e-mail: commits-unsubscr...@cassandra.apache.org For additional commands, e-mail: commits-h...@cassandra.apache.org
[jira] [Commented] (CASSANDRA-13915) Create a Docker container to build the docs
[ https://issues.apache.org/jira/browse/CASSANDRA-13915?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16191625#comment-16191625 ] Jon Haddad commented on CASSANDRA-13915: Yes, I think removing the built docs falls under the responsibility of realclean. > Create a Docker container to build the docs > --- > > Key: CASSANDRA-13915 > URL: https://issues.apache.org/jira/browse/CASSANDRA-13915 > Project: Cassandra > Issue Type: Improvement >Reporter: Joaquin Casares >Assignee: Joaquin Casares > > As requested by [~rustyrazorblade], I will be adding a Docker container to > build the docs without any prereqs (other than Docker). -- This message was sent by Atlassian JIRA (v6.4.14#64029) - To unsubscribe, e-mail: commits-unsubscr...@cassandra.apache.org For additional commands, e-mail: commits-h...@cassandra.apache.org
[jira] [Commented] (CASSANDRA-13915) Create a Docker container to build the docs
[ https://issues.apache.org/jira/browse/CASSANDRA-13915?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16191473#comment-16191473 ] Joaquin Casares commented on CASSANDRA-13915: - My feelings exactly on having too many scars of not running {{ant realclean}}. But I also understand quick turnaround times for this container. I've remove the {{ant realclean}}, but added a few documentation notes to prevent future scars. [~jasobrown], {{Dockerfile}} and {{docker-compose.yml}} are the default names for working with Docker-related projects. Because both files are within {{doc/}} it typically implies that it will be a doc-centric container. I have however added a short comment to the top of the {{Dockerfile}} and {{docker-compose.yml}} to make this more evident. Do also note that {{docker-compose build build-docs}} will only take so long the first time. If the command is executed again and no changes to the {{Dockerfile}} have occurred, docker will used the previously-built cached images. Were you two fine with me adding the {{doc/build}} directory to the {{ant realclean}}? Just wanted to confirm. > Create a Docker container to build the docs > --- > > Key: CASSANDRA-13915 > URL: https://issues.apache.org/jira/browse/CASSANDRA-13915 > Project: Cassandra > Issue Type: Improvement >Reporter: Joaquin Casares >Assignee: Joaquin Casares > > As requested by [~rustyrazorblade], I will be adding a Docker container to > build the docs without any prereqs (other than Docker). -- This message was sent by Atlassian JIRA (v6.4.14#64029) - To unsubscribe, e-mail: commits-unsubscr...@cassandra.apache.org For additional commands, e-mail: commits-h...@cassandra.apache.org
[jira] [Commented] (CASSANDRA-13915) Create a Docker container to build the docs
[ https://issues.apache.org/jira/browse/CASSANDRA-13915?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16190692#comment-16190692 ] Jason Brown commented on CASSANDRA-13915: - [~rustyrazorblade] I have way too many scars of *not* running {{ant realclean}} that I instinctively always run it. However, for the purposes of working on the docs, I agree that quicker turn around time is probably more important than cleaning everything, everytime. [~j.casares] you add the docker file as {{/doc/Dockerfile}}. Is that possibly confusing for anyone who thinks that this will allow them to build a docker container to actually run cassandra? At a minimum, add a quick comment at the top of the file in case someone skips everything else in our distro, looking for a docker file. Same goes for the {{/doc/docker-compose.yml}}, as well. > Create a Docker container to build the docs > --- > > Key: CASSANDRA-13915 > URL: https://issues.apache.org/jira/browse/CASSANDRA-13915 > Project: Cassandra > Issue Type: Improvement >Reporter: Joaquin Casares >Assignee: Joaquin Casares > > As requested by [~rustyrazorblade], I will be adding a Docker container to > build the docs without any prereqs (other than Docker). -- This message was sent by Atlassian JIRA (v6.4.14#64029) - To unsubscribe, e-mail: commits-unsubscr...@cassandra.apache.org For additional commands, e-mail: commits-h...@cassandra.apache.org
[jira] [Commented] (CASSANDRA-13915) Create a Docker container to build the docs
[ https://issues.apache.org/jira/browse/CASSANDRA-13915?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16190665#comment-16190665 ] Jon Haddad commented on CASSANDRA-13915: I'm not wild about always running {{ant realclean}} between builds of docs. Most of the time it's unnecessary and makes the previous process takes quite a bit longer, which will be kind of a pain if you want to make a lot of edits as I like to. If someone wants to {{realclean}}, then can do it explicitly, but I think it should be removed from this process. Some numbers on my mac laptop: Building the docker image: {code} docker-compose build build-docs 0.89s user 0.37s system 1% cpu 1:46.89 total {code} Building the docs w/ realclean: {code} docker-compose run build-docs 0.69s user 0.16s system 4% cpu 18.090 total {code} Building without realclean: {code} docker-compose run build-docs 0.67s user 0.15s system 12% cpu 6.625 total {code} [~jasobrown] what do you think? > Create a Docker container to build the docs > --- > > Key: CASSANDRA-13915 > URL: https://issues.apache.org/jira/browse/CASSANDRA-13915 > Project: Cassandra > Issue Type: Improvement >Reporter: Joaquin Casares >Assignee: Joaquin Casares > > As requested by [~rustyrazorblade], I will be adding a Docker container to > build the docs without any prereqs (other than Docker). -- This message was sent by Atlassian JIRA (v6.4.14#64029) - To unsubscribe, e-mail: commits-unsubscr...@cassandra.apache.org For additional commands, e-mail: commits-h...@cassandra.apache.org
[jira] [Commented] (CASSANDRA-13915) Create a Docker container to build the docs
[ https://issues.apache.org/jira/browse/CASSANDRA-13915?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16186581#comment-16186581 ] Joaquin Casares commented on CASSANDRA-13915: - Thanks for taking a look [~jasobrown]! I just pushed an update to my branch so that it supports Docker Compose 2.0+ yamls. Basically, the version of Docker Compose in 17.04 seems to be a bit old, but I'm not using any 2.1-specific features, so I just downgraded the version on my {{docker-compose.yml}} from {{2.1}} to {{2.0}}. Applying the new commit should work well for you. Thanks again! > Create a Docker container to build the docs > --- > > Key: CASSANDRA-13915 > URL: https://issues.apache.org/jira/browse/CASSANDRA-13915 > Project: Cassandra > Issue Type: Improvement >Reporter: Joaquin Casares >Assignee: Joaquin Casares > > As requested by [~rustyrazorblade], I will be adding a Docker container to > build the docs without any prereqs (other than Docker). -- This message was sent by Atlassian JIRA (v6.4.14#64029) - To unsubscribe, e-mail: commits-unsubscr...@cassandra.apache.org For additional commands, e-mail: commits-h...@cassandra.apache.org
[jira] [Commented] (CASSANDRA-13915) Create a Docker container to build the docs
[ https://issues.apache.org/jira/browse/CASSANDRA-13915?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16186557#comment-16186557 ] Jason Brown commented on CASSANDRA-13915: - Ok, so I applied this patch to trunk. I had docker installed, but I needed to install docker-compose. I'm using ubuntu 17.04 and just the docker/docker-compase packages it provides via apt-get: docker version = "Docker version 1.12.6, build 78d1802", docker-compose version = "docker-compose version 1.8.0, build unknown". I get the following error when using the instructions in the patch: {notformat} ERROR: Version in "./docker-compose.yml" is unsupported. You might be seeing this error because you're using the wrong Compose file version. Either specify a version of "2" (or "2.0") and place your service definitions under the `services` key, or omit the `version` key and place your service definitions at the root of the file to use version 1. For more on the Compose file format versions, see https://docs.docker.com/compose/compose-file/ {noformat} Note: I know nothing about docker, so this might be a noob problem. > Create a Docker container to build the docs > --- > > Key: CASSANDRA-13915 > URL: https://issues.apache.org/jira/browse/CASSANDRA-13915 > Project: Cassandra > Issue Type: Improvement >Reporter: Joaquin Casares >Assignee: Joaquin Casares > > As requested by [~rustyrazorblade], I will be adding a Docker container to > build the docs without any prereqs (other than Docker). -- This message was sent by Atlassian JIRA (v6.4.14#64029) - To unsubscribe, e-mail: commits-unsubscr...@cassandra.apache.org For additional commands, e-mail: commits-h...@cassandra.apache.org
[jira] [Commented] (CASSANDRA-13915) Create a Docker container to build the docs
[ https://issues.apache.org/jira/browse/CASSANDRA-13915?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16186448#comment-16186448 ] Jon Haddad commented on CASSANDRA-13915: The more eyes the better, especially given the lack of attention docs have had historically. I'll still also review it Monday. Once this is done I'll work with [~mshuler] to do the back half, pushing the updating site docs up and documenting that process. > Create a Docker container to build the docs > --- > > Key: CASSANDRA-13915 > URL: https://issues.apache.org/jira/browse/CASSANDRA-13915 > Project: Cassandra > Issue Type: Improvement >Reporter: Joaquin Casares >Assignee: Joaquin Casares > > As requested by [~rustyrazorblade], I will be adding a Docker container to > build the docs without any prereqs (other than Docker). -- This message was sent by Atlassian JIRA (v6.4.14#64029) - To unsubscribe, e-mail: commits-unsubscr...@cassandra.apache.org For additional commands, e-mail: commits-h...@cassandra.apache.org
[jira] [Commented] (CASSANDRA-13915) Create a Docker container to build the docs
[ https://issues.apache.org/jira/browse/CASSANDRA-13915?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16186442#comment-16186442 ] Jason Brown commented on CASSANDRA-13915: - [~rustyrazorblade] [~mshuler] I love this. Thanks for the details! I can review the ticket, as well, since I've started poking into it anyway. > Create a Docker container to build the docs > --- > > Key: CASSANDRA-13915 > URL: https://issues.apache.org/jira/browse/CASSANDRA-13915 > Project: Cassandra > Issue Type: Improvement >Reporter: Joaquin Casares >Assignee: Joaquin Casares > > As requested by [~rustyrazorblade], I will be adding a Docker container to > build the docs without any prereqs (other than Docker). -- This message was sent by Atlassian JIRA (v6.4.14#64029) - To unsubscribe, e-mail: commits-unsubscr...@cassandra.apache.org For additional commands, e-mail: commits-h...@cassandra.apache.org
[jira] [Commented] (CASSANDRA-13915) Create a Docker container to build the docs
[ https://issues.apache.org/jira/browse/CASSANDRA-13915?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16186405#comment-16186405 ] Michael Shuler commented on CASSANDRA-13915: I found that even building docs on the same version of jekyll, etc. on Mac or Linux produced different resulting html files. We thought a docker instance with all the right bits installed and a run script should produce the same results for anyone. > Create a Docker container to build the docs > --- > > Key: CASSANDRA-13915 > URL: https://issues.apache.org/jira/browse/CASSANDRA-13915 > Project: Cassandra > Issue Type: Improvement >Reporter: Joaquin Casares >Assignee: Joaquin Casares > > As requested by [~rustyrazorblade], I will be adding a Docker container to > build the docs without any prereqs (other than Docker). -- This message was sent by Atlassian JIRA (v6.4.14#64029) - To unsubscribe, e-mail: commits-unsubscr...@cassandra.apache.org For additional commands, e-mail: commits-h...@cassandra.apache.org
[jira] [Commented] (CASSANDRA-13915) Create a Docker container to build the docs
[ https://issues.apache.org/jira/browse/CASSANDRA-13915?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16186395#comment-16186395 ] Jon Haddad commented on CASSANDRA-13915: [~jasobrown] Currently the dependencies of the docs are difficult to install correctly. I had worked with [~bdeggleston] on CASSANDRA-13253 a ways back and simply getting the docs to build _at all_ in a reliable and repeatable required several rounds of attempts and turned into an unnecessary time suck. Blake and I had a difficult time getting it working despite a combined 15+ years working with Python and maybe 10 years working with Sphinx. I'm looking to simplify the process and make it easier for folks to build and contribute to the documentation. Contributing to the docs, in my opinion, should have a very low barrier to entry. Getting the dependencies right isn't a great use of time, and Docker lets us standardize it. The docker file will also be helpful in standardizing the way we publish the docs to the site, which, at the moment, is very difficult and rarely done. The desire to do this partially came out of a discussion I had with [~mshuler] at NGCC where I expressed interest in making the online docs easier to update. > Create a Docker container to build the docs > --- > > Key: CASSANDRA-13915 > URL: https://issues.apache.org/jira/browse/CASSANDRA-13915 > Project: Cassandra > Issue Type: Improvement >Reporter: Joaquin Casares >Assignee: Joaquin Casares > > As requested by [~rustyrazorblade], I will be adding a Docker container to > build the docs without any prereqs (other than Docker). -- This message was sent by Atlassian JIRA (v6.4.14#64029) - To unsubscribe, e-mail: commits-unsubscr...@cassandra.apache.org For additional commands, e-mail: commits-h...@cassandra.apache.org
[jira] [Commented] (CASSANDRA-13915) Create a Docker container to build the docs
[ https://issues.apache.org/jira/browse/CASSANDRA-13915?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16186203#comment-16186203 ] Jason Brown commented on CASSANDRA-13915: - [~rustyrazorblade] & [~j.casares] stoopidly naive question: why do we need Docker to build our docs? > Create a Docker container to build the docs > --- > > Key: CASSANDRA-13915 > URL: https://issues.apache.org/jira/browse/CASSANDRA-13915 > Project: Cassandra > Issue Type: Improvement >Reporter: Joaquin Casares >Assignee: Joaquin Casares > > As requested by [~rustyrazorblade], I will be adding a Docker container to > build the docs without any prereqs (other than Docker). -- This message was sent by Atlassian JIRA (v6.4.14#64029) - To unsubscribe, e-mail: commits-unsubscr...@cassandra.apache.org For additional commands, e-mail: commits-h...@cassandra.apache.org
[jira] [Commented] (CASSANDRA-13915) Create a Docker container to build the docs
[ https://issues.apache.org/jira/browse/CASSANDRA-13915?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16186191#comment-16186191 ] Joaquin Casares commented on CASSANDRA-13915: - [~rustyrazorblade] could you review https://github.com/apache/cassandra/pull/154? Thanks! > Create a Docker container to build the docs > --- > > Key: CASSANDRA-13915 > URL: https://issues.apache.org/jira/browse/CASSANDRA-13915 > Project: Cassandra > Issue Type: Improvement >Reporter: Joaquin Casares >Assignee: Joaquin Casares > > As requested by [~rustyrazorblade], I will be adding a Docker container to > build the docs without any prereqs (other than Docker). -- This message was sent by Atlassian JIRA (v6.4.14#64029) - To unsubscribe, e-mail: commits-unsubscr...@cassandra.apache.org For additional commands, e-mail: commits-h...@cassandra.apache.org
[jira] [Commented] (CASSANDRA-13915) Create a Docker container to build the docs
[ https://issues.apache.org/jira/browse/CASSANDRA-13915?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16186190#comment-16186190 ] ASF GitHub Bot commented on CASSANDRA-13915: GitHub user joaquincasares opened a pull request: https://github.com/apache/cassandra/pull/154 CASSANDRA-13915 https://issues.apache.org/jira/browse/CASSANDRA-13915 You can merge this pull request into a Git repository by running: $ git pull https://github.com/joaquincasares/cassandra CASSANDRA-13915 Alternatively you can review and apply these changes as the patch at: https://github.com/apache/cassandra/pull/154.patch To close this pull request, make a commit to your master/trunk branch with (at least) the following in the commit message: This closes #154 commit eb558abda811dbbf42f6881382f883c752702d7b Author: Joaquin CasaresDate: 2017-09-29T18:17:45Z Fix documentation build warnings commit 9c35e3aa3f3dc2c736eae6f327676828d2c475b6 Author: Joaquin Casares Date: 2017-09-29T18:19:49Z Include removing doc/build as part of 'ant realclean' commit 2bcef57e744ee209caf74c6bac067d7599381304 Author: Joaquin Casares Date: 2017-09-29T18:23:21Z Add a Docker Compose setup to build the docs > Create a Docker container to build the docs > --- > > Key: CASSANDRA-13915 > URL: https://issues.apache.org/jira/browse/CASSANDRA-13915 > Project: Cassandra > Issue Type: Improvement >Reporter: Joaquin Casares >Assignee: Joaquin Casares > > As requested by [~rustyrazorblade], I will be adding a Docker container to > build the docs without any prereqs (other than Docker). -- This message was sent by Atlassian JIRA (v6.4.14#64029) - To unsubscribe, e-mail: commits-unsubscr...@cassandra.apache.org For additional commands, e-mail: commits-h...@cassandra.apache.org