Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

release 3.4.0 docs #2562

Merged
merged 2 commits into from
Feb 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions .github/workflows/deploy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@ name: Publish docs via GitHub Pages
on:
push:
branches:
- master
- v3.4.0

jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
fetch-depth: 0 # fetch all commits/branches
fetch-depth: 1 # fetch all commits/branches

- name: Setup Python
uses: actions/setup-python@v1
Expand All @@ -27,7 +27,8 @@ jobs:
- name: mike
run: |
git fetch origin gh-pages --depth=1 # fix mike's CI update
mike deploy master -p --rebase
mike deploy 3.4.0 -p --rebase
mike set-default 3.4.0 -p --rebase
mike list

- name: show git branch
Expand All @@ -37,7 +38,7 @@ jobs:
git checkout gh-pages
- name: Compress
run: |
tar -vczf nebula-docs.tar.gz master versions.json *.html
tar -vczf nebula-docs.tar.gz 3.4.0 versions.json *.html

- name: Transfer
# uses: garygrossgarten/github-action-scp@release
Expand All @@ -60,7 +61,7 @@ jobs:
mkdir -p /usr/web/nebula-docs/
tar -xzf /usr/web/nebula-docs.tar.gz -C /usr/web/nebula-docs/
mkdir -p /usr/web/nebula-docs/site/pdf/
cp -f /usr/web/nebula-docs/master/pdf/NebulaGraph-CN.pdf /usr/web/nebula-docs/site/pdf/NebulaGraph-book.pdf
cp -f /usr/web/nebula-docs/3.4.0/pdf/NebulaGraph-CN.pdf /usr/web/nebula-docs/site/pdf/NebulaGraph-book.pdf

# pip3 install --upgrade pip
# pip3 install -r /usr/web/nebula-docs/requirement.txt
Expand Down
8 changes: 4 additions & 4 deletions docs-2.0/stylesheets/extra.css
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@

/* NebulaGraph 黑夜主题色 */
:root{
--md-primary-fg-color: #FF0000; /* 导航栏页面颜色 */
--md-accent-fg-color: #49BDF0; /* 选中/悬浮颜色 */
--md-primary-fg-color: #00d5ff; /* 导航栏页面颜色 */
--md-accent-fg-color: #f049d4; /* 选中/悬浮颜色 */
}

/* NebulaGraph 白天主题色 */
[data-md-color-scheme="nebula"]{
--md-primary-fg-color: #F7A7A0; /* 导航栏页面颜色 */
--md-accent-fg-color: #7DBB7C; /* 选中/悬浮颜色 */
--md-primary-fg-color: #0FA37F; /* 导航栏页面颜色 */
--md-accent-fg-color: #5b1cdb; /* 选中/悬浮颜色 */

--md-code-fg-color: rgb(12, 21, 26); /* 代码段字体色 */
--md-code-bg-color: #eaebec;/* 代码段背景色 */
Expand Down
124 changes: 62 additions & 62 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ site_url: https://docs.nebula-graph.com.cn/
repo_name: 'vesoft-inc/nebula'
repo_url: 'https://github.com/vesoft-inc/nebula'
docs_dir: docs-2.0
copyright: Copyright © 2022 NebulaGraph - 浙ICP备20010487号
copyright: Copyright © 2023 NebulaGraph - 浙ICP备20010487号

# modify when release:
edit_uri: 'https://github.com/vesoft-inc/nebula-docs-cn/edit/master/docs-2.0/'
Expand Down Expand Up @@ -81,7 +81,7 @@ plugins:
- 4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-from-200-to-latest.md

# 仅发布包含企业版功能的文档版本时,注释以下页面
# begin
# ent.begin
# - 3.ngql-guide/6.functions-and-expressions/17.ES-function.md
# - 4.deployment-and-installation/deploy-license.md
# - 5.configurations-and-logs/2.log-management/audit-log.md
Expand All @@ -95,7 +95,7 @@ plugins:
# - 20.appendix/8.about-license/
# - nebula-dashboard-ent/4.cluster-operator/operator/scale.md
# - 6.monitor-and-metrics/3.bbox
# end
# ent.end
# comm.begin
# comm.end

Expand All @@ -107,8 +107,8 @@ plugins:

# modify when release:
- with-pdf:
copyright: 2022 vesoft Inc.
cover_subtitle: master
copyright: 2023 vesoft Inc.
cover_subtitle: v3.4.0
author: 吴敏,周瑶,梁振亚,杨怡璇,黄凤仙
cover: true
back_cover: true
Expand All @@ -130,7 +130,7 @@ extra:
# For conditional rendering
# Valid options: enterprise, community, both
# enterprise means this version is for the Enterprise only. And so on in a similar fashion
database_edition: community
database_edition: both
# Language selector.
alternate:
- name: English
Expand All @@ -152,38 +152,38 @@ extra:
master: master
base20: 2.0
base200: 2.0.0
branch: release-3.3
tag: v3.3.0
branch: release-3.4
tag: v3.4.0
studio:
base111b: 1.1.1-beta
base220: 2.2.1
base300: 3.0.0
release: 3.5.0
tag: v3.5.0
tag: v3.6.0
explorer:
release: 3.2.0
branch: release-3.2
tag: v3.2.0
release: 3.4.0
branch: release-3.4
tag: v3.4.0
exchange_ent:
release: 3.0.0
branch: v3.0.0
tag: v3.0.0
release: 3.4.0
branch: release-3.4
tag: v3.4.0
exchange:
release: 3.3.0
branch: release-3.3
tag: v3.3.0
release: 3.4.0
branch: release-3.4
tag: v3.4.0
importer:
release: 3.1.0
branch: release-3.1
tag: v3.1.0
release: 3.4.0
branch: release-3.4
tag: v3.4.0
algorithm:
release: 3.0.0
branch: v3.0.0
tag: v3.0.0
plato:
release: 3.3.0
branch: release-3.3
tag: v3.3.0
release: 3.4.0
branch: release-3.4
tag: v3.4.0
sparkconnector:
release: 3.3.0
branch: release-3.3
Expand All @@ -193,70 +193,70 @@ extra:
branch: release-3.3
tag: v3.3.0
dockercompose:
release: 3.2.0
branch: release-3.2
tag: v3.2.0
release: 3.4.0
branch: release-3.4
tag: v3.4.0
dashboard:
release: 3.2.0
tag: v3.2.0
release: 3.4.0
tag: v3.4.0
base100: 1.0.0
branch: release-3.2
branch: release-3.4
dashboard_ent:
release: 3.2.0
tag: v3.2.0
branch: release-3.2
release: 3.4.0
tag: v3.4.0
branch: release-3.4
console:
release: 3.4.0
branch: release-3.4
tag: v3.4.0
br:
release: 3.3.0
branch: release-3.3
tag: v3.3.0
br:
release: 0.6.1
branch: master
tag: v0.6.1
br_ent:
release: 0.7.0
tag: v0.7.0
release: 3.4.0
tag: v3.4.0
agent:
release: 0.2.0
tag: v0.2.0
release: 3.4.0
tag: v3.4.0
cpp:
release: 3.3.0
branch: release-3.3
tag: v3.3.0
release: 3.4.0
branch: release-3.4
tag: v3.4.0
java:
release: 3.3.0
branch: release-3.3
tag: v3.3.0
release: 3.4.0
branch: release-3.4
tag: v3.4.0
python:
release: 3.3.0
branch: release-3.3
tag: v3.3.0
release: 3.4.0
branch: release-3.4
tag: v3.4.0
go:
release: 3.3.0
branch: release-3.3
tag: v3.3.0
release: 3.4.0
branch: release-3.4
tag: v3.4.0
bench:
release: 1.2.0
branch: release-1.2
tag: v1.2.0
operator:
release: 1.3.0
tag: v1.3.0
branch: release-1.3
release: 1.4.0
tag: v1.4.0
branch: release-1.4
upgrade_from: 3.0.0
upgrade_to: 3.3.x
exporter:
release: 3.3.0
branch: release-3.3
tag: v3.3.0
gateway:
release: 3.1.2
branch: release-3.1
tag: v3.1.2
release: 3.4.0
branch: release-3.4
tag: v3.4.0
bbox:
release: 3.3.0
branch: release-3.3
tag: v3.3.0
release: 3.4.0
branch: release-3.4
tag: v3.4.0
cloud:
azureRelease: 3.1.1 # Azure云兼容的最新内核版本
aliyunRelease: 3.1.1 # 阿里云兼容的最新内核版本
Expand Down