You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@skywalking.apache.org by GitBox <gi...@apache.org> on 2021/02/11 16:53:33 UTC

[GitHub] [skywalking-website] Jtrust opened a new pull request #215: Integrate project documentations into the website

Jtrust opened a new pull request #215:
URL: https://github.com/apache/skywalking-website/pull/215


   - [x] Integrate project documentations into the website
   we can use build command: `npm run build`


----------------------------------------------------------------
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.

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



[GitHub] [skywalking-website] wu-sheng commented on a change in pull request #215: Integrate project documentations into the website

Posted by GitBox <gi...@apache.org>.
wu-sheng commented on a change in pull request #215:
URL: https://github.com/apache/skywalking-website/pull/215#discussion_r574912153



##########
File path: data/docs.yml
##########
@@ -6,11 +6,18 @@
       description: The documentation including core concepts, protocols, Java agent, OAP backend, and UI
       user: apache
       repo: skywalking
+      gitUrl: https://github.com/apache/skywalking.git
       docs:
         - version: v8.4.0
-          link: https://github.com/apache/skywalking/tree/v8.4.0/docs
+          link: /docs/main/v8.4.0/readme/
+          commitId: bf8574b07f01dcff681994e5fec599fe2bb7887b
+          localPath: /content/docs/main/v8.4.0
+          sidebarConfigFile: main_8_4_0
         - version: v8.3.0
-          link: https://github.com/apache/skywalking/tree/8.3.0/docs-hotfix/docs
+          link: /docs/main/v8.3.0/readme/
+          commitId: 7748639cf6be88cd629fb757cc5994b7a9184cd1
+          localPath: /content/docs/main/v8.3.0
+          sidebarConfigFile: main_8_3_0

Review comment:
       We should remove this

##########
File path: data/docs.yml
##########
@@ -35,6 +42,7 @@
       description: SkyWalking Nginx Agent provides the native tracing capability for Nginx powered by Nginx LUA module.
       user: apache
       repo: skywalking-nginx-lua
+      gitUrl: https://github.com/apache/skywalking-nginx-lua.git

Review comment:
       Why add this?




----------------------------------------------------------------
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.

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



[GitHub] [skywalking-website] Jtrust commented on a change in pull request #215: Integrate project documentations into the website

Posted by GitBox <gi...@apache.org>.
Jtrust commented on a change in pull request #215:
URL: https://github.com/apache/skywalking-website/pull/215#discussion_r575280592



##########
File path: data/docs.yml
##########
@@ -6,11 +6,18 @@
       description: The documentation including core concepts, protocols, Java agent, OAP backend, and UI
       user: apache
       repo: skywalking
+      gitUrl: https://github.com/apache/skywalking.git
       docs:
         - version: v8.4.0
-          link: https://github.com/apache/skywalking/tree/v8.4.0/docs
+          link: /docs/main/v8.4.0/readme/
+          commitId: bf8574b07f01dcff681994e5fec599fe2bb7887b
+          localPath: /content/docs/main/v8.4.0
+          sidebarConfigFile: main_8_4_0
         - version: v8.3.0
-          link: https://github.com/apache/skywalking/tree/8.3.0/docs-hotfix/docs
+          link: /docs/main/v8.3.0/readme/
+          commitId: 7748639cf6be88cd629fb757cc5994b7a9184cd1
+          localPath: /content/docs/main/v8.3.0
+          sidebarConfigFile: main_8_3_0

Review comment:
       I'm going to modify it




----------------------------------------------------------------
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.

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



[GitHub] [skywalking-website] wu-sheng commented on a change in pull request #215: Integrate project documentations into the website

Posted by GitBox <gi...@apache.org>.
wu-sheng commented on a change in pull request #215:
URL: https://github.com/apache/skywalking-website/pull/215#discussion_r575793516



##########
File path: doc.sh
##########
@@ -0,0 +1,32 @@
+#!/bin/bash
+
+
+repo=$1
+gitUrl=$2
+commitId=$3
+localPath=$4
+sidebarConfigFile=$5
+
+
+if [ ! -d "./tmp" ]; then
+  mkdir ./tmp
+fi
+cd ./tmp
+
+if [ ! -d "./${repo}" ]; then
+  git clone ${gitUrl}
+  cd ./${repo}
+  else
+  cd ./${repo}
+  git pull origin master
+fi
+
+git reset --hard ${commitId}
+
+if [ -d "../../${localPath}" ]; then
+  rm -rf ../../${localPath}
+fi
+mkdir -p ../../${localPath}

Review comment:
       > Hi, just for sure, this localPath is used to store every project's docs?
   
   They will. Every repo will have `name`, `repo`, `version`, `commit id`. Then, all path are generated automatically based on rules.




----------------------------------------------------------------
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.

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



[GitHub] [skywalking-website] juzhiyuan commented on a change in pull request #215: Integrate project documentations into the website

Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on a change in pull request #215:
URL: https://github.com/apache/skywalking-website/pull/215#discussion_r575784562



##########
File path: doc.sh
##########
@@ -0,0 +1,32 @@
+#!/bin/bash
+
+
+repo=$1
+gitUrl=$2
+commitId=$3
+localPath=$4
+sidebarConfigFile=$5
+
+
+if [ ! -d "./tmp" ]; then
+  mkdir ./tmp
+fi
+cd ./tmp
+
+if [ ! -d "./${repo}" ]; then
+  git clone ${gitUrl}
+  cd ./${repo}
+  else
+  cd ./${repo}
+  git pull origin master
+fi
+
+git reset --hard ${commitId}
+
+if [ -d "../../${localPath}" ]; then
+  rm -rf ../../${localPath}
+fi
+mkdir -p ../../${localPath}

Review comment:
       Hi, just for sure, this `localPath` is used to store every project's docs?
   
   After pull & move those docs to that folder, do we need to make some changes to them, so after building, every project's docs would have a universal view-feeling?




----------------------------------------------------------------
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.

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



[GitHub] [skywalking-website] Jtrust commented on a change in pull request #215: Integrate project documentations into the website

Posted by GitBox <gi...@apache.org>.
Jtrust commented on a change in pull request #215:
URL: https://github.com/apache/skywalking-website/pull/215#discussion_r575278987



##########
File path: data/docs.yml
##########
@@ -35,6 +42,7 @@
       description: SkyWalking Nginx Agent provides the native tracing capability for Nginx powered by Nginx LUA module.
       user: apache
       repo: skywalking-nginx-lua
+      gitUrl: https://github.com/apache/skywalking-nginx-lua.git

Review comment:
       It should be removed




----------------------------------------------------------------
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.

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



[GitHub] [skywalking-website] wu-sheng merged pull request #215: Integrate project documentations into the website

Posted by GitBox <gi...@apache.org>.
wu-sheng merged pull request #215:
URL: https://github.com/apache/skywalking-website/pull/215


   


----------------------------------------------------------------
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.

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



[GitHub] [skywalking-website] juzhiyuan commented on a change in pull request #215: Integrate project documentations into the website

Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on a change in pull request #215:
URL: https://github.com/apache/skywalking-website/pull/215#discussion_r575804306



##########
File path: doc.sh
##########
@@ -0,0 +1,32 @@
+#!/bin/bash
+
+
+repo=$1
+gitUrl=$2
+commitId=$3
+localPath=$4
+sidebarConfigFile=$5
+
+
+if [ ! -d "./tmp" ]; then
+  mkdir ./tmp
+fi
+cd ./tmp
+
+if [ ! -d "./${repo}" ]; then
+  git clone ${gitUrl}
+  cd ./${repo}
+  else
+  cd ./${repo}
+  git pull origin master
+fi
+
+git reset --hard ${commitId}
+
+if [ -d "../../${localPath}" ]; then
+  rm -rf ../../${localPath}
+fi
+mkdir -p ../../${localPath}

Review comment:
       Thanks! I will take a look :)




----------------------------------------------------------------
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.

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



[GitHub] [skywalking-website] wu-sheng commented on a change in pull request #215: Integrate project documentations into the website

Posted by GitBox <gi...@apache.org>.
wu-sheng commented on a change in pull request #215:
URL: https://github.com/apache/skywalking-website/pull/215#discussion_r575794002



##########
File path: doc.sh
##########
@@ -0,0 +1,32 @@
+#!/bin/bash
+
+
+repo=$1
+gitUrl=$2
+commitId=$3
+localPath=$4
+sidebarConfigFile=$5
+
+
+if [ ! -d "./tmp" ]; then
+  mkdir ./tmp
+fi
+cd ./tmp
+
+if [ ! -d "./${repo}" ]; then
+  git clone ${gitUrl}
+  cd ./${repo}
+  else
+  cd ./${repo}
+  git pull origin master
+fi
+
+git reset --hard ${commitId}
+
+if [ -d "../../${localPath}" ]; then
+  rm -rf ../../${localPath}
+fi
+mkdir -p ../../${localPath}

Review comment:
       Last preview is available here, https://deploy-preview-215--hopeful-fermat-fec5f0.netlify.app/
   
   ![image](https://user-images.githubusercontent.com/5441976/107875404-93791f00-6efa-11eb-8bc7-f43655d14d92.png)
   
   These are available for preview.




----------------------------------------------------------------
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.

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