Re: [PR] simple build doc [incubator-celeborn-website]

2023-11-22 Thread via GitHub


cxzl25 merged PR #27:
URL: https://github.com/apache/incubator-celeborn-website/pull/27


-- 
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: dev-unsubscr...@celeborn.apache.org

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



Re: [PR] simple build doc [incubator-celeborn-website]

2023-11-19 Thread via GitHub


pan3793 commented on code in PR #27:
URL: 
https://github.com/apache/incubator-celeborn-website/pull/27#discussion_r1398627965


##
.github/workflows/site.yaml:
##
@@ -48,38 +48,11 @@ jobs:
   git add .gitignore
   git commit -m 'gitignore'
   - run: |
-  wget 
https://github.com/apache/incubator-celeborn/archive/refs/heads/main.tar.gz
-  tar -xzf main.tar.gz
-  cd incubator-celeborn-main
-  mkdocs build
-  cd ..
-  mkdir -p docs
-  if [ -d docs/latest ]; then rm -r docs/latest; fi
-  mv incubator-celeborn-main/site docs/latest
-  git add .
-  git commit -m 'docs/main'
+  ./dev/build_docs.sh 'heads/main.tar.gz'
   - run: |
-  wget 
https://github.com/apache/incubator-celeborn/archive/refs/tags/v0.2.1-incubating.tar.gz
-  tar -xzf v0.2.1-incubating.tar.gz
-  cd incubator-celeborn-0.2.1-incubating
-  mkdocs build
-  cd ..
-  mkdir -p docs
-  if [ -d docs/0.2.1-incubating ]; then rm -r docs/0.2.1-incubating; fi
-  mv incubator-celeborn-0.2.1-incubating/site docs/0.2.1-incubating
-  git add .
-  git commit -m 'docs/0.2.1-incubating'
+  ./dev/build_docs.sh 'tags/v0.2.1-incubating.tar.gz'
   - run: |
-  wget 
https://github.com/apache/incubator-celeborn/archive/refs/tags/v0.3.1-incubating.tar.gz
-  tar -xzf v0.3.1-incubating.tar.gz
-  cd incubator-celeborn-0.3.1-incubating
-  mkdocs build
-  cd ..
-  mkdir -p docs
-  if [ -d docs/0.3.1-incubating ]; then rm -r docs/0.3.1-incubating; fi
-  mv incubator-celeborn-0.3.1-incubating/site docs/0.3.1-incubating
-  git add .
-  git commit -m 'docs/0.3.1-incubating'
+  ./dev/build_docs.sh 'tags/v0.3.1-incubating.tar.gz'

Review Comment:
   ```
   - run: |
 ./dev/build_docs.sh main latest
 ./dev/build_docs.sh v0.2.1-incubating 0.2.1-incubating
 ...
   ```



-- 
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: dev-unsubscr...@celeborn.apache.org

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



Re: [PR] simple build doc [incubator-celeborn-website]

2023-11-19 Thread via GitHub


pan3793 commented on code in PR #27:
URL: 
https://github.com/apache/incubator-celeborn-website/pull/27#discussion_r1398627965


##
.github/workflows/site.yaml:
##
@@ -48,38 +48,11 @@ jobs:
   git add .gitignore
   git commit -m 'gitignore'
   - run: |
-  wget 
https://github.com/apache/incubator-celeborn/archive/refs/heads/main.tar.gz
-  tar -xzf main.tar.gz
-  cd incubator-celeborn-main
-  mkdocs build
-  cd ..
-  mkdir -p docs
-  if [ -d docs/latest ]; then rm -r docs/latest; fi
-  mv incubator-celeborn-main/site docs/latest
-  git add .
-  git commit -m 'docs/main'
+  ./dev/build_docs.sh 'heads/main.tar.gz'
   - run: |
-  wget 
https://github.com/apache/incubator-celeborn/archive/refs/tags/v0.2.1-incubating.tar.gz
-  tar -xzf v0.2.1-incubating.tar.gz
-  cd incubator-celeborn-0.2.1-incubating
-  mkdocs build
-  cd ..
-  mkdir -p docs
-  if [ -d docs/0.2.1-incubating ]; then rm -r docs/0.2.1-incubating; fi
-  mv incubator-celeborn-0.2.1-incubating/site docs/0.2.1-incubating
-  git add .
-  git commit -m 'docs/0.2.1-incubating'
+  ./dev/build_docs.sh 'tags/v0.2.1-incubating.tar.gz'
   - run: |
-  wget 
https://github.com/apache/incubator-celeborn/archive/refs/tags/v0.3.1-incubating.tar.gz
-  tar -xzf v0.3.1-incubating.tar.gz
-  cd incubator-celeborn-0.3.1-incubating
-  mkdocs build
-  cd ..
-  mkdir -p docs
-  if [ -d docs/0.3.1-incubating ]; then rm -r docs/0.3.1-incubating; fi
-  mv incubator-celeborn-0.3.1-incubating/site docs/0.3.1-incubating
-  git add .
-  git commit -m 'docs/0.3.1-incubating'
+  ./dev/build_docs.sh 'tags/v0.3.1-incubating.tar.gz'

Review Comment:
   ```
   - run: |
 ./dev/build_docs.sh main latest
 ./dev/build_docs.sh v0.3.1-incubating 0.3.1-incubating
 ...
   ```



-- 
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: dev-unsubscr...@celeborn.apache.org

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



Re: [PR] simple build doc [incubator-celeborn-website]

2023-11-19 Thread via GitHub


pan3793 commented on code in PR #27:
URL: 
https://github.com/apache/incubator-celeborn-website/pull/27#discussion_r1398627548


##
.github/workflows/site.yaml:
##
@@ -48,38 +48,11 @@ jobs:
   git add .gitignore
   git commit -m 'gitignore'
   - run: |
-  wget 
https://github.com/apache/incubator-celeborn/archive/refs/heads/main.tar.gz
-  tar -xzf main.tar.gz
-  cd incubator-celeborn-main
-  mkdocs build
-  cd ..
-  mkdir -p docs
-  if [ -d docs/latest ]; then rm -r docs/latest; fi
-  mv incubator-celeborn-main/site docs/latest
-  git add .
-  git commit -m 'docs/main'
+  ./dev/build_docs.sh 'heads/main.tar.gz'
   - run: |
-  wget 
https://github.com/apache/incubator-celeborn/archive/refs/tags/v0.2.1-incubating.tar.gz
-  tar -xzf v0.2.1-incubating.tar.gz
-  cd incubator-celeborn-0.2.1-incubating
-  mkdocs build
-  cd ..
-  mkdir -p docs
-  if [ -d docs/0.2.1-incubating ]; then rm -r docs/0.2.1-incubating; fi
-  mv incubator-celeborn-0.2.1-incubating/site docs/0.2.1-incubating
-  git add .
-  git commit -m 'docs/0.2.1-incubating'
+  ./dev/build_docs.sh 'tags/v0.2.1-incubating.tar.gz'
   - run: |
-  wget 
https://github.com/apache/incubator-celeborn/archive/refs/tags/v0.3.1-incubating.tar.gz
-  tar -xzf v0.3.1-incubating.tar.gz
-  cd incubator-celeborn-0.3.1-incubating
-  mkdocs build
-  cd ..
-  mkdir -p docs
-  if [ -d docs/0.3.1-incubating ]; then rm -r docs/0.3.1-incubating; fi
-  mv incubator-celeborn-0.3.1-incubating/site docs/0.3.1-incubating
-  git add .
-  git commit -m 'docs/0.3.1-incubating'
+  ./dev/build_docs.sh 'tags/v0.3.1-incubating.tar.gz'

Review Comment:
   in the future, we may want to link the "main" to "unstable" or "nightly", 
and link the "latest release version" to "latest"



-- 
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: dev-unsubscr...@celeborn.apache.org

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



Re: [PR] simple build doc [incubator-celeborn-website]

2023-11-19 Thread via GitHub


pan3793 commented on code in PR #27:
URL: 
https://github.com/apache/incubator-celeborn-website/pull/27#discussion_r1398627004


##
dev/build_docs.sh:
##
@@ -0,0 +1,42 @@
+#!/usr/bin/env bash
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+set -o pipefail
+set -e
+set -x
+

Review Comment:
   move this file to `.github/bin` since it is only used in CI



-- 
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: dev-unsubscr...@celeborn.apache.org

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



Re: [PR] simple build doc [incubator-celeborn-website]

2023-11-19 Thread via GitHub


pan3793 commented on code in PR #27:
URL: 
https://github.com/apache/incubator-celeborn-website/pull/27#discussion_r1398626743


##
dev/build_docs.sh:
##
@@ -0,0 +1,42 @@
+#!/usr/bin/env bash
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+set -o pipefail
+set -e
+set -x
+

Review Comment:
   add the usage with comments or define a usage function



##
dev/build_docs.sh:
##
@@ -0,0 +1,42 @@
+#!/usr/bin/env bash
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+set -o pipefail
+set -e
+set -x
+

Review Comment:
   add the usage in comment or define a usage function



-- 
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: dev-unsubscr...@celeborn.apache.org

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



Re: [PR] simple build doc [incubator-celeborn-website]

2023-11-19 Thread via GitHub


pan3793 commented on code in PR #27:
URL: 
https://github.com/apache/incubator-celeborn-website/pull/27#discussion_r1398626291


##
.github/workflows/site.yaml:
##
@@ -48,38 +48,11 @@ jobs:
   git add .gitignore
   git commit -m 'gitignore'
   - run: |
-  wget 
https://github.com/apache/incubator-celeborn/archive/refs/heads/main.tar.gz
-  tar -xzf main.tar.gz
-  cd incubator-celeborn-main
-  mkdocs build
-  cd ..
-  mkdir -p docs
-  if [ -d docs/latest ]; then rm -r docs/latest; fi
-  mv incubator-celeborn-main/site docs/latest
-  git add .
-  git commit -m 'docs/main'
+  ./dev/build_docs.sh 'heads/main.tar.gz'
   - run: |
-  wget 
https://github.com/apache/incubator-celeborn/archive/refs/tags/v0.2.1-incubating.tar.gz
-  tar -xzf v0.2.1-incubating.tar.gz
-  cd incubator-celeborn-0.2.1-incubating
-  mkdocs build
-  cd ..
-  mkdir -p docs
-  if [ -d docs/0.2.1-incubating ]; then rm -r docs/0.2.1-incubating; fi
-  mv incubator-celeborn-0.2.1-incubating/site docs/0.2.1-incubating
-  git add .
-  git commit -m 'docs/0.2.1-incubating'
+  ./dev/build_docs.sh 'tags/v0.2.1-incubating.tar.gz'
   - run: |
-  wget 
https://github.com/apache/incubator-celeborn/archive/refs/tags/v0.3.1-incubating.tar.gz
-  tar -xzf v0.3.1-incubating.tar.gz
-  cd incubator-celeborn-0.3.1-incubating
-  mkdocs build
-  cd ..
-  mkdir -p docs
-  if [ -d docs/0.3.1-incubating ]; then rm -r docs/0.3.1-incubating; fi
-  mv incubator-celeborn-0.3.1-incubating/site docs/0.3.1-incubating
-  git add .
-  git commit -m 'docs/0.3.1-incubating'
+  ./dev/build_docs.sh 'tags/v0.3.1-incubating.tar.gz'

Review Comment:
   should be simple if we make the script accept `''`, `''` as args.
   
   e.g. 
   ```
   build_docs.sh main latest
   build_docs.sh v0.3.1-incubating 0.3.1-incubating
   ```
   



-- 
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: dev-unsubscr...@celeborn.apache.org

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



Re: [PR] simple build doc [incubator-celeborn-website]

2023-11-19 Thread via GitHub


pan3793 commented on code in PR #27:
URL: 
https://github.com/apache/incubator-celeborn-website/pull/27#discussion_r1398626291


##
.github/workflows/site.yaml:
##
@@ -48,38 +48,11 @@ jobs:
   git add .gitignore
   git commit -m 'gitignore'
   - run: |
-  wget 
https://github.com/apache/incubator-celeborn/archive/refs/heads/main.tar.gz
-  tar -xzf main.tar.gz
-  cd incubator-celeborn-main
-  mkdocs build
-  cd ..
-  mkdir -p docs
-  if [ -d docs/latest ]; then rm -r docs/latest; fi
-  mv incubator-celeborn-main/site docs/latest
-  git add .
-  git commit -m 'docs/main'
+  ./dev/build_docs.sh 'heads/main.tar.gz'
   - run: |
-  wget 
https://github.com/apache/incubator-celeborn/archive/refs/tags/v0.2.1-incubating.tar.gz
-  tar -xzf v0.2.1-incubating.tar.gz
-  cd incubator-celeborn-0.2.1-incubating
-  mkdocs build
-  cd ..
-  mkdir -p docs
-  if [ -d docs/0.2.1-incubating ]; then rm -r docs/0.2.1-incubating; fi
-  mv incubator-celeborn-0.2.1-incubating/site docs/0.2.1-incubating
-  git add .
-  git commit -m 'docs/0.2.1-incubating'
+  ./dev/build_docs.sh 'tags/v0.2.1-incubating.tar.gz'
   - run: |
-  wget 
https://github.com/apache/incubator-celeborn/archive/refs/tags/v0.3.1-incubating.tar.gz
-  tar -xzf v0.3.1-incubating.tar.gz
-  cd incubator-celeborn-0.3.1-incubating
-  mkdocs build
-  cd ..
-  mkdir -p docs
-  if [ -d docs/0.3.1-incubating ]; then rm -r docs/0.3.1-incubating; fi
-  mv incubator-celeborn-0.3.1-incubating/site docs/0.3.1-incubating
-  git add .
-  git commit -m 'docs/0.3.1-incubating'
+  ./dev/build_docs.sh 'tags/v0.3.1-incubating.tar.gz'

Review Comment:
   should be simple if we make the script accept '', '' as args.
   
   e.g. 
   ```
   build_docs.sh main latest
   build_docs.sh v0.3.1-incubating 0.3.1-incubating
   ```
   



-- 
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: dev-unsubscr...@celeborn.apache.org

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



[PR] simple build doc [incubator-celeborn-website]

2023-11-17 Thread via GitHub


cxzl25 opened a new pull request, #27:
URL: https://github.com/apache/incubator-celeborn-website/pull/27

   local test
   
   https://github.com/apache/incubator-celeborn-website/assets/3898450/d59f9fa4-ddce-45b3-b144-71247b8ed7c7";>
   


-- 
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: dev-unsubscr...@celeborn.apache.org

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