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

update release guide and fix navigation error #272

Merged
merged 1 commit into from
Jun 26, 2021
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
17 changes: 1 addition & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,22 +33,7 @@ Please sent your PR to the master branch instead of asf-site.

# How to push the change to apache website

* Switch to asf-site branch

`git checkout asf-site`

* Merge the changes of master branch

`git merge master`

* Generate the website static pages

`bundle exec jekyll build`

* Commit the changes into git repo

`git add content `
`git commit -m "publish website"`
[Follow This Script](script/release.sh)

**Note that tested versions of the tools covered in this section are as following,**

Expand Down
6 changes: 2 additions & 4 deletions _data/navigation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -100,8 +100,7 @@ t:

- title: ServiceCenter User Guide
children:

- title: 2.0.0
- title: 2.0.0
url: https://service-center.readthedocs.io/en/latest/user-guides.html

- title: Kie User Guide
Expand Down Expand Up @@ -293,8 +292,7 @@ t:

- title: ServiceCenter用户手册
children:

- title: 2.0.0(英文版)
- title: 2.0.0(英文版)
url: https://service-center.readthedocs.io/en/latest/user-guides.html

- title: Kie 用户手册
Expand Down
27 changes: 24 additions & 3 deletions script/release
Original file line number Diff line number Diff line change
@@ -1,7 +1,28 @@
#!/bin/sh
#push a release to branch asf-site

## publish website steps
CUR_DIR=$PWD

bundle update
## downlowd code
git clone https://github.com/apache/servicecomb-website.git servicecomb-website-master
cp -R servicecomb-website-master servicecomb-website-publish
git clone https://github.com/huaweicse/servicecomb-java-chassis-doc.git

git push origin asf-site
## build source
cd $CUR_DIR/servicecomb-website-master
git checkout -f master
bundle exec jekyll build

## copy complied files
cd $CUR_DIR/servicecomb-website-publish
git checkout -B liubao -t origin/asf-site
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It can be changed to the website repo and the committer has the right to push the change.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The push step is commented, and the publisher should use this step to commit changes and create a PR.

rm -R content/*
mkdir content/references
cp -R $CUR_DIR/servicecomb-website-master/content/* ./content/
cp -R $CUR_DIR/servicecomb-java-chassis-doc/docs/* ./content/references/
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's better to add links to the reference, as we have other docs need to link such as kie.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Folder can not use symbolic link. This way is the best option that can use now.

git add content
git commit -m "publish website"

## push
# git remote add liubao https://github.com/liubao68/servicecomb-website
# git push --force --progress liubao liubao:liubao