[#492] feat(doc): Document website framework #512

xunliu · 2023-10-14T03:47:20Z

What changes were proposed in this pull request?

Add launch document website script into docs/launch-docs-website.sh

You can execute ./launch-docs-website.sh command to launch the docs website your locally, and you can open http://localhost:1313/ to visit.
If you add or modify any documents in the docs directory, you need execute ./launch-docs-website.sh update to update document website.

Why are the changes needed?

We are considering using hugo to generate the Graviton project document framework.

hugo is a popular tool for Documentation Sites, an Active community with better functionality.
gohugo is an Apache 2.0 license, After Gravtion to open source, no modifications are needed.

Fix: #492

Does this PR introduce any user-facing change?

N/A

How was this patch tested?

N/A

github-actions · 2023-10-14T03:48:20Z

Code Coverage Report

Overall Project	62.16%	🟢

There is no coverage information present for the Files changed

xunliu · 2023-10-14T07:30:16Z

hi @yuqi1129 @jerryshao , Please help me review this PR, Thanks!

yuqi1129 · 2023-10-14T14:57:05Z

docs/launch-docs-website.sh

+
+OS=$(uname -s)
+if [ "$OS" != "Darwin" ]; then
+  echo "Currently only support macOS. In the future we can support other OS."


Does the means it can only build on Darwin or deploy on Darwin?

yuqi1129 · 2023-10-14T15:03:34Z

docs/launch-docs-website.sh

+  fi
+
+  if [ ! -d "${bin}/build/hugo" ]; then
+    tar -xzf "${bin}/build/${HUGO_PACKAGE_NAME}" -C "${bin}/build"


Do we need to remove the tar file after it's depressed?

yuqi1129 · 2023-10-14T15:05:35Z

docs/README.md

+
+## Launch Graviton document website
+
+Execute `./launch-docs-website.sh` scripts, It will create the Graviton document website in locally, It follows these steps:


website in locally ---> website locally, It will --> it will and the same for It follows

yuqi1129 · 2023-10-14T15:08:53Z

docs/README.md

+
+## Add or modify a document
+
+To add a new document to the Graviton website, follow these steps:


We should(need to) follow these steps:

yuqi1129 · 2023-10-14T15:09:57Z

docs/README.md

+
+To add a new document to the Graviton website, follow these steps:
+
+1. Create a new markdown file in the `docs` directory any directory.


in the docs directory any directory, it may have syntax errors.

yuqi1129 · 2023-10-14T15:12:33Z

docs/README.md

+To add a new document to the Graviton website, follow these steps:
+
+1. Create a new markdown file in the `docs` directory any directory.
+2. In the markdown file, include the following header at the beginning, because `Hugo` use it create website link list.


Maybe you can say:
For markdown files, we should include the following header at the beginning because...

yuqi1129 · 2023-10-14T15:15:25Z

docs/launch-docs-website.sh

+if [[ "$1" == "update" ]]; then
+  copy_docs
+else
+  launch_website


What will happen if we execute ./launch-docs-website.sh a_random_value?

jerryshao · 2023-10-16T02:36:23Z

docs/launch-docs-website.sh

+  fi
+
+  if [ ! -f "${bin}/build/${HUGO_PACKAGE_NAME}" ]; then
+    wget -q -P "${bin}/build" ${HUGO_DOWNLOAD_URL}


wget is not install in macOs by default, you'd better using curl or others.

Changed to curl -L command to download.

jerryshao · 2023-10-16T02:49:07Z

docs/launch-docs-website.sh

+
+  # Setting the Hugo theme
+  cd ${bin}/build/web
+  git clone https://github.com/datastratolabs/gohugo-theme-ananke.git themes/ananke


What is this "datastratolabs", did you create a group to store this them file? I'm not sure what's the purpose of it, can you explain more?

I have changed the width of the post page of this theme from 60% to 100%.

Also I'm worried about this theme being deleted

So I clone this repo to datastratolabs for safekeeping.

jerryshao · 2023-10-17T11:56:02Z

@xunliu please take a review my changes.

xunliu · 2023-10-17T12:13:08Z

docs/launch-docs-website.sh

@@ -71,11 +71,11 @@ function launch_website() {
  fi

  if [ ! -d "${bin}/build/hugo" ]; then


I think, That's the way it should be.

if [ ! -f "${bin}/build/hugo" ]; then if [ ! -f "${bin}/build/${HUGO_PACKAGE_NAME}" ]; then wget -q -P "${bin}/build" ${HUGO_DOWNLOAD_URL} fi tar -xzf "${bin}/build/${HUGO_PACKAGE_NAME}" -C "${bin}/build" fi

This is not a big deal, I think we can improve the script later on.

xunliu · 2023-10-17T12:19:34Z

@jerryshao Thank you for helping me improve this PR.
LGTM

### What changes were proposed in this pull request? Add launch document website script into `docs/launch-docs-website.sh` + You can execute `./launch-docs-website.sh` command to launch the docs website your locally, and you can open `http://localhost:1313/` to visit. + If you add or modify any documents in the docs directory, you need execute `./launch-docs-website.sh update` to update document website. ### Why are the changes needed? We are considering using hugo to generate the Graviton project document framework. + [hugo](https://github.com/gohugoio/hugo) is a popular tool for Documentation Sites, an Active community with better functionality. + gohugo is an Apache 2.0 license, After Gravtion to open source, no modifications are needed. Fix: #492 ### Does this PR introduce _any_ user-facing change? N/A ### How was this patch tested? N/A --------- Co-authored-by: Jerry Shao <[email protected]>

xunliu requested a review from jerryshao October 14, 2023 03:47

xunliu requested a review from yuqi1129 October 14, 2023 07:29

yuqi1129 reviewed Oct 14, 2023

View reviewed changes

jerryshao reviewed Oct 16, 2023

View reviewed changes

xunliu and others added 4 commits October 17, 2023 19:24

[#492] feat(doc): Document framework

f1b9b8d

Fixed

e092dff

Rename from Graviton to Gravitino

5bafd0e

Improve the script

31d7f06

Improve the script

fdc8c71

xunliu commented Oct 17, 2023

View reviewed changes

jerryshao approved these changes Oct 17, 2023

View reviewed changes

jerryshao merged commit 821a805 into apache:main Oct 17, 2023
2 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[#492] feat(doc): Document website framework #512

[#492] feat(doc): Document website framework #512

xunliu commented Oct 14, 2023

github-actions bot commented Oct 14, 2023 •

edited

Loading

xunliu commented Oct 14, 2023

yuqi1129 Oct 14, 2023

yuqi1129 Oct 14, 2023

yuqi1129 Oct 14, 2023

xunliu Oct 17, 2023

yuqi1129 Oct 14, 2023

xunliu Oct 17, 2023

yuqi1129 Oct 14, 2023

xunliu Oct 17, 2023

yuqi1129 Oct 14, 2023

xunliu Oct 17, 2023

yuqi1129 Oct 14, 2023

xunliu Oct 17, 2023

jerryshao Oct 16, 2023

xunliu Oct 17, 2023

jerryshao Oct 16, 2023

xunliu Oct 17, 2023

jerryshao commented Oct 17, 2023

xunliu Oct 17, 2023 •

edited

Loading

jerryshao Oct 17, 2023

xunliu commented Oct 17, 2023


		## Launch Graviton document website

		Execute `./launch-docs-website.sh` scripts, It will create the Graviton document website in locally, It follows these steps:


		## Add or modify a document

		To add a new document to the Graviton website, follow these steps:


		To add a new document to the Graviton website, follow these steps:

		1. Create a new markdown file in the `docs` directory any directory.

		@@ -71,11 +71,11 @@ function launch_website() {
		fi

		if [ ! -d "${bin}/build/hugo" ]; then

[#492] feat(doc): Document website framework #512

[#492] feat(doc): Document website framework #512

Conversation

xunliu commented Oct 14, 2023

What changes were proposed in this pull request?

Why are the changes needed?

Does this PR introduce any user-facing change?

How was this patch tested?

github-actions bot commented Oct 14, 2023 • edited Loading

Code Coverage Report

xunliu commented Oct 14, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jerryshao commented Oct 17, 2023

xunliu Oct 17, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xunliu commented Oct 17, 2023

github-actions bot commented Oct 14, 2023 •

edited

Loading

xunliu Oct 17, 2023 •

edited

Loading