develop guide document (#1838)

.github/workflows/mkbook.yml

@@ -0,0 +1,66 @@
+# Sample workflow for building and deploying a mdBook site to GitHub Pages
+#
+# To get started with mdBook see: https://rust-lang.github.io/mdBook/index.html
+#
+name: Deploy mdBook site to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["develop"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    env:
+      MDBOOK_VERSION: 0.4.36
+    steps:
+      - uses: actions/checkout@v4
+      - name: Prepare
+        run: |
+          mkdir mdbook
+          mv docs mdbook/src
+          
+      - name: Install mdBook
+        run: |
+          curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf -y | sh
+          rustup update
+          cargo install --version ${MDBOOK_VERSION} mdbook
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v4
+      - name: Build with mdBook
+        run: mdbook build
+        working-directory: mdbook
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./mdbook/book
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

docs/README.md

@@ -12,11 +12,19 @@ At present, the guide is composed of the following parts:
 1. **Get started**: Setting up the development environment, build and connect to the OceanBase server, the subsections are based on an imagined newbie user journey.
     1. [Install toolchain](toolchain.md)
     2. [Get the code, build and run](build-and-run.md)
-    3. Set up an IDE
-    4. [Write and run unit tests](unittest.md)
-    5. [Debug](debug.md)
-    6. Commit code and submit a pull request
-2. **Contribute to OceanBase**: helps you quickly get involved in the OceanBase community, which illustrates what contributions you can make and how to quickly make one.
+    3. [Set up an IDE](ide-settings.md)
+    4. [Coding Convensions](coding-convension.md)
+    5. [Write and run unit tests](unittest.md)
+    6. [Running MySQL test](mysqltest.md)
+    7. [Debug](debug.md)
+    8. Commit code and submit a pull request
+  
+    More information before you start a big feature developing, you should read content below and it can help you understand oceanbase better.
+    1. [Logging System](logging.md)
+    2. [Memory Management](memory.md)
+    3. [Containers](container.md)
+    4. [Coding Standard](coding_standard.md)
+3. **Contribute to OceanBase**: helps you quickly get involved in the OceanBase community, which illustrates what contributions you can make and how to quickly make one.
 
 ## User documents
 

docs/SUMMARY.md

@@ -0,0 +1,14 @@
+# Summary
+
+[OceanBase Development Guide](README.md)
+[Install toolchain](toolchain.md)
+[Get the code, build and run](build-and-run.md)
+[Set up an IDE](ide-settings.md)
+[Coding Convensions](coding-convension.md)
+[Write and run unit tests](unittest.md)
+[Running MySQL test](mysqltest.md)
+[Debug](debug.md)
+[Logging System](logging.md)
+[Memory Management](memory.md)
+[Containers](container.md)
+[Coding Standard](coding_standard.md)