You are viewing a plain text version of this content. The canonical link for it is here.
Posted to pr@cassandra.apache.org by GitBox <gi...@apache.org> on 2021/12/07 11:27:16 UTC

[GitHub] [cassandra-website] ossarga opened a new pull request #83: CASSANDRA-16913: Updated build-ui.zip URL

ossarga opened a new pull request #83:
URL: https://github.com/apache/cassandra-website/pull/83


   * Generated bundle-ui.zip and added it to repository under site-ui/build/
   * Updated bundle-ui URL in site-content Dockerfile to point to GitHub trunk version of build-ui.zip
   
   patch by Anthony Grasso; reviewed by ... for CASSANDRA-16913


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org


[GitHub] [cassandra-website] michaelsembwever commented on a change in pull request #83: CASSANDRA-16913: Updated build-ui.zip URL

Posted by GitBox <gi...@apache.org>.
michaelsembwever commented on a change in pull request #83:
URL: https://github.com/apache/cassandra-website/pull/83#discussion_r764071047



##########
File path: site-content/Dockerfile
##########
@@ -99,7 +98,7 @@ ENV ANTORA_CONTENT_SOURCES_CASSANDRA_WEBSITE_BRANCHES="HEAD"
 ENV ANTORA_CONTENT_SOURCES_CASSANDRA_WEBSITE_TAGS=""
 ENV ANTORA_CONTENT_SOURCES_CASSANDRA_WEBSITE_START_PATH="site-content/source"
 
-ENV ANTORA_UI_BUNDLE_URL="https://github.com/ianjevans/antora-ui-datastax/releases/download/v0.1oss/ui-bundle.zip"
+ENV ANTORA_UI_BUNDLE_URL="https://github.com/apache/cassandra-website/raw/trunk/site-ui/build/ui-bundle.zip"

Review comment:
       I'm thinking, if i `./run.sh` on a custom branch, i'd expect the `site-ui/build/ui-bundle.zip` to be used from that branch. It would not be intuitive that the file is there but not used and I have to specify the `-z` option.
   
   




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org


[GitHub] [cassandra-website] michaelsembwever commented on a change in pull request #83: CASSANDRA-16913: Updated build-ui.zip URL

Posted by GitBox <gi...@apache.org>.
michaelsembwever commented on a change in pull request #83:
URL: https://github.com/apache/cassandra-website/pull/83#discussion_r765872709



##########
File path: run.sh
##########
@@ -111,7 +111,7 @@ Options
                                   specified multiple times. The valid values for REPOSITORY are only 'cassandra' and
                                   'cassandra-website'. The values for TAGS are split by comma with no spaces. The
                                   repository and list of tags are split by a colon ':'. For example:
-                                    -t cassandra:cassandra-4.0,cassandra-3.11,cassandra-3.0
+                                    -t cassandra:cassandra-4.0,cassandra-3.11

Review comment:
       ah yes, i was thinking of the `-b …` option. 
   
   Those tags will not work atm. (They won't work until from the releases that happen after Lorina's branches are merged.)




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org


[GitHub] [cassandra-website] michaelsembwever commented on a change in pull request #83: CASSANDRA-16913: Updated build-ui.zip URL

Posted by GitBox <gi...@apache.org>.
michaelsembwever commented on a change in pull request #83:
URL: https://github.com/apache/cassandra-website/pull/83#discussion_r765873823



##########
File path: run.sh
##########
@@ -111,7 +111,7 @@ Options
                                   specified multiple times. The valid values for REPOSITORY are only 'cassandra' and
                                   'cassandra-website'. The values for TAGS are split by comma with no spaces. The
                                   repository and list of tags are split by a colon ':'. For example:
-                                    -t cassandra:cassandra-4.0,cassandra-3.11,cassandra-3.0
+                                    -t cassandra:cassandra-4.0.1,cassandra-3.11.11

Review comment:
       ```suggestion
                                       -b cassandra:trunk,cassandra-4.0,cassandra-3.11 -t cassandra:cassandra-4.0.2,cassandra-3.11.12
   ```




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org


[GitHub] [cassandra-website] ossarga commented on a change in pull request #83: CASSANDRA-16913: Updated build-ui.zip URL

Posted by GitBox <gi...@apache.org>.
ossarga commented on a change in pull request #83:
URL: https://github.com/apache/cassandra-website/pull/83#discussion_r764730915



##########
File path: site-content/Dockerfile
##########
@@ -99,7 +98,7 @@ ENV ANTORA_CONTENT_SOURCES_CASSANDRA_WEBSITE_BRANCHES="HEAD"
 ENV ANTORA_CONTENT_SOURCES_CASSANDRA_WEBSITE_TAGS=""
 ENV ANTORA_CONTENT_SOURCES_CASSANDRA_WEBSITE_START_PATH="site-content/source"
 
-ENV ANTORA_UI_BUNDLE_URL="https://github.com/ianjevans/antora-ui-datastax/releases/download/v0.1oss/ui-bundle.zip"
+ENV ANTORA_UI_BUNDLE_URL="https://github.com/apache/cassandra-website/raw/trunk/site-ui/build/ui-bundle.zip"

Review comment:
       Thanks @michaelsembwever. I have updated the `./run.sh` logic (which turned out to be easier than I thought) and pushed the changes to the branch.




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org


[GitHub] [cassandra-website] michaelsembwever commented on a change in pull request #83: CASSANDRA-16913: Updated build-ui.zip URL

Posted by GitBox <gi...@apache.org>.
michaelsembwever commented on a change in pull request #83:
URL: https://github.com/apache/cassandra-website/pull/83#discussion_r764071047



##########
File path: site-content/Dockerfile
##########
@@ -99,7 +98,7 @@ ENV ANTORA_CONTENT_SOURCES_CASSANDRA_WEBSITE_BRANCHES="HEAD"
 ENV ANTORA_CONTENT_SOURCES_CASSANDRA_WEBSITE_TAGS=""
 ENV ANTORA_CONTENT_SOURCES_CASSANDRA_WEBSITE_START_PATH="site-content/source"
 
-ENV ANTORA_UI_BUNDLE_URL="https://github.com/ianjevans/antora-ui-datastax/releases/download/v0.1oss/ui-bundle.zip"
+ENV ANTORA_UI_BUNDLE_URL="https://github.com/apache/cassandra-website/raw/trunk/site-ui/build/ui-bundle.zip"

Review comment:
       I'm thinking, if i `./run.sh` on a custom branch, i'd expect the `site-ui/build/ui-bundle.zip` to be used from that branch. It would not be intuitive that the file is there but not used and I have to specify the `-z` option.
   
   Like, what if you make changes to the site-ui, test away and commit. But never realised those ui changes were not actually getting tested… I'm thinking that's unintuitive and going to catch folk out




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org


[GitHub] [cassandra-website] michaelsembwever commented on a change in pull request #83: CASSANDRA-16913: Updated build-ui.zip URL

Posted by GitBox <gi...@apache.org>.
michaelsembwever commented on a change in pull request #83:
URL: https://github.com/apache/cassandra-website/pull/83#discussion_r763910778



##########
File path: site-content/Dockerfile
##########
@@ -99,7 +98,7 @@ ENV ANTORA_CONTENT_SOURCES_CASSANDRA_WEBSITE_BRANCHES="HEAD"
 ENV ANTORA_CONTENT_SOURCES_CASSANDRA_WEBSITE_TAGS=""
 ENV ANTORA_CONTENT_SOURCES_CASSANDRA_WEBSITE_START_PATH="site-content/source"
 
-ENV ANTORA_UI_BUNDLE_URL="https://github.com/ianjevans/antora-ui-datastax/releases/download/v0.1oss/ui-bundle.zip"
+ENV ANTORA_UI_BUNDLE_URL="https://github.com/apache/cassandra-website/raw/trunk/site-ui/build/ui-bundle.zip"

Review comment:
       don't we want the local path, i.e. `site-ui/build/ui-bundle.zip`?  (e.g. we've generated it locally)




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org


[GitHub] [cassandra-website] ossarga commented on a change in pull request #83: CASSANDRA-16913: Updated build-ui.zip URL

Posted by GitBox <gi...@apache.org>.
ossarga commented on a change in pull request #83:
URL: https://github.com/apache/cassandra-website/pull/83#discussion_r764079046



##########
File path: site-content/Dockerfile
##########
@@ -99,7 +98,7 @@ ENV ANTORA_CONTENT_SOURCES_CASSANDRA_WEBSITE_BRANCHES="HEAD"
 ENV ANTORA_CONTENT_SOURCES_CASSANDRA_WEBSITE_TAGS=""
 ENV ANTORA_CONTENT_SOURCES_CASSANDRA_WEBSITE_START_PATH="site-content/source"
 
-ENV ANTORA_UI_BUNDLE_URL="https://github.com/ianjevans/antora-ui-datastax/releases/download/v0.1oss/ui-bundle.zip"
+ENV ANTORA_UI_BUNDLE_URL="https://github.com/apache/cassandra-website/raw/trunk/site-ui/build/ui-bundle.zip"

Review comment:
       Ok. I think we should leave the patch to the Dockerfile as is, and include the logic changes to the `run.sh` as well. This way the container can run without any external input, and `./run.sh` has the desired behaviour you have described.




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org


[GitHub] [cassandra-website] ossarga commented on a change in pull request #83: CASSANDRA-16913: Updated build-ui.zip URL

Posted by GitBox <gi...@apache.org>.
ossarga commented on a change in pull request #83:
URL: https://github.com/apache/cassandra-website/pull/83#discussion_r764079046



##########
File path: site-content/Dockerfile
##########
@@ -99,7 +98,7 @@ ENV ANTORA_CONTENT_SOURCES_CASSANDRA_WEBSITE_BRANCHES="HEAD"
 ENV ANTORA_CONTENT_SOURCES_CASSANDRA_WEBSITE_TAGS=""
 ENV ANTORA_CONTENT_SOURCES_CASSANDRA_WEBSITE_START_PATH="site-content/source"
 
-ENV ANTORA_UI_BUNDLE_URL="https://github.com/ianjevans/antora-ui-datastax/releases/download/v0.1oss/ui-bundle.zip"
+ENV ANTORA_UI_BUNDLE_URL="https://github.com/apache/cassandra-website/raw/trunk/site-ui/build/ui-bundle.zip"

Review comment:
       Ok. We I think we should leave the patch to the Dockerfile as is, and include the logic changes to the `run.sh` as well. This way the container can run without any external input, and `./run.sh` has the desired behaviour you have described.




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org


[GitHub] [cassandra-website] michaelsembwever commented on a change in pull request #83: CASSANDRA-16913: Updated build-ui.zip URL

Posted by GitBox <gi...@apache.org>.
michaelsembwever commented on a change in pull request #83:
URL: https://github.com/apache/cassandra-website/pull/83#discussion_r764905083



##########
File path: run.sh
##########
@@ -111,7 +111,7 @@ Options
                                   specified multiple times. The valid values for REPOSITORY are only 'cassandra' and
                                   'cassandra-website'. The values for TAGS are split by comma with no spaces. The
                                   repository and list of tags are split by a colon ':'. For example:
-                                    -t cassandra:cassandra-4.0,cassandra-3.11,cassandra-3.0
+                                    -t cassandra:cassandra-4.0,cassandra-3.11

Review comment:
       ```suggestion
                                       -t cassandra:trunk,cassandra-4.0,cassandra-3.11
   ```
   ```suggestion
                                       -t cassandra:cassandra-4.0,cassandra-3.11
   ```




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org


[GitHub] [cassandra-website] ossarga commented on a change in pull request #83: CASSANDRA-16913: Updated build-ui.zip URL

Posted by GitBox <gi...@apache.org>.
ossarga commented on a change in pull request #83:
URL: https://github.com/apache/cassandra-website/pull/83#discussion_r764045703



##########
File path: site-content/Dockerfile
##########
@@ -99,7 +98,7 @@ ENV ANTORA_CONTENT_SOURCES_CASSANDRA_WEBSITE_BRANCHES="HEAD"
 ENV ANTORA_CONTENT_SOURCES_CASSANDRA_WEBSITE_TAGS=""
 ENV ANTORA_CONTENT_SOURCES_CASSANDRA_WEBSITE_START_PATH="site-content/source"
 
-ENV ANTORA_UI_BUNDLE_URL="https://github.com/ianjevans/antora-ui-datastax/releases/download/v0.1oss/ui-bundle.zip"
+ENV ANTORA_UI_BUNDLE_URL="https://github.com/apache/cassandra-website/raw/trunk/site-ui/build/ui-bundle.zip"

Review comment:
       We could set the ui-bundle.zip to be the local path. However, such a change is has an unrealised complexity to it.
   
   We would no longer need to change the Dockerfile, rather we would need change the `run.sh`. Specifically, the `run.sh` would need to change such that if `-z` is supplied as an argument that path is used, otherwise the local ui-bundle.zip file is mounted into the container. In either case, the `run.sh` would always set the value of the environment variable `ANTORA_UI_BUNDLE_URL`. Thus, defining a default value for it in the Dockerfile would be irrelevant.
   
   Such a change would tightly couple the `run.sh` script to the Docker container. This is because the container would need to rely on external input for a file that is required by Antora to render the website. Currently on trunk, all critical files required by Antora have default values defined in the Dockerfile. This means, the container can run without any external input and render the website.
   
   The current patch removes the need to specify the `-z` option so the user can rely on the container defaults to render the website.




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org


[GitHub] [cassandra-website] michaelsembwever commented on a change in pull request #83: CASSANDRA-16913: Updated build-ui.zip URL

Posted by GitBox <gi...@apache.org>.
michaelsembwever commented on a change in pull request #83:
URL: https://github.com/apache/cassandra-website/pull/83#discussion_r764905083



##########
File path: run.sh
##########
@@ -111,7 +111,7 @@ Options
                                   specified multiple times. The valid values for REPOSITORY are only 'cassandra' and
                                   'cassandra-website'. The values for TAGS are split by comma with no spaces. The
                                   repository and list of tags are split by a colon ':'. For example:
-                                    -t cassandra:cassandra-4.0,cassandra-3.11,cassandra-3.0
+                                    -t cassandra:cassandra-4.0,cassandra-3.11

Review comment:
       ```suggestion
                                       -t cassandra:trunk,cassandra-4.0,cassandra-3.11
   ```
   




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org


[GitHub] [cassandra-website] michaelsembwever commented on a change in pull request #83: CASSANDRA-16913: Updated build-ui.zip URL

Posted by GitBox <gi...@apache.org>.
michaelsembwever commented on a change in pull request #83:
URL: https://github.com/apache/cassandra-website/pull/83#discussion_r764387191



##########
File path: site-content/Dockerfile
##########
@@ -99,7 +98,7 @@ ENV ANTORA_CONTENT_SOURCES_CASSANDRA_WEBSITE_BRANCHES="HEAD"
 ENV ANTORA_CONTENT_SOURCES_CASSANDRA_WEBSITE_TAGS=""
 ENV ANTORA_CONTENT_SOURCES_CASSANDRA_WEBSITE_START_PATH="site-content/source"
 
-ENV ANTORA_UI_BUNDLE_URL="https://github.com/ianjevans/antora-ui-datastax/releases/download/v0.1oss/ui-bundle.zip"
+ENV ANTORA_UI_BUNDLE_URL="https://github.com/apache/cassandra-website/raw/trunk/site-ui/build/ui-bundle.zip"

Review comment:
       ah gotcha. if the logic change is so put into `/.run.sh` (i agree it should be), then that means the docker ENV will always be overridden when using the `/run.sh` approach. if that is the case, then i agree it makes sense to make the default ENV  ANTORA_UI_BUNDLE_URL point to the trunk url 👍 




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org


[GitHub] [cassandra-website] ossarga commented on a change in pull request #83: CASSANDRA-16913: Updated build-ui.zip URL

Posted by GitBox <gi...@apache.org>.
ossarga commented on a change in pull request #83:
URL: https://github.com/apache/cassandra-website/pull/83#discussion_r765709587



##########
File path: run.sh
##########
@@ -111,7 +111,7 @@ Options
                                   specified multiple times. The valid values for REPOSITORY are only 'cassandra' and
                                   'cassandra-website'. The values for TAGS are split by comma with no spaces. The
                                   repository and list of tags are split by a colon ':'. For example:
-                                    -t cassandra:cassandra-4.0,cassandra-3.11,cassandra-3.0
+                                    -t cassandra:cassandra-4.0,cassandra-3.11

Review comment:
       The `-t` option is for tags on a repository. Does the Cassandra project have a tag called `trunk` as well?




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org


[GitHub] [cassandra-website] ossarga commented on a change in pull request #83: CASSANDRA-16913: Updated build-ui.zip URL

Posted by GitBox <gi...@apache.org>.
ossarga commented on a change in pull request #83:
URL: https://github.com/apache/cassandra-website/pull/83#discussion_r765709587



##########
File path: run.sh
##########
@@ -111,7 +111,7 @@ Options
                                   specified multiple times. The valid values for REPOSITORY are only 'cassandra' and
                                   'cassandra-website'. The values for TAGS are split by comma with no spaces. The
                                   repository and list of tags are split by a colon ':'. For example:
-                                    -t cassandra:cassandra-4.0,cassandra-3.11,cassandra-3.0
+                                    -t cassandra:cassandra-4.0,cassandra-3.11

Review comment:
       The `-t` option is for tags on a repository. Does the Cassandra project have a tag called `trunk` as well?
   
   Note, I fixed the other tags though to be `cassandra-4.0.1` and `cassandra-3.11.11` so example is more accurate.




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org


[GitHub] [cassandra-website] michaelsembwever merged pull request #83: CASSANDRA-16913: Updated build-ui.zip URL

Posted by GitBox <gi...@apache.org>.
michaelsembwever merged pull request #83:
URL: https://github.com/apache/cassandra-website/pull/83


   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org