Skip to content

Commit

Permalink
Merge refactor website (#2293)
Browse files Browse the repository at this point in the history
* brand new homepage

* brand new homepage

* update base url

* update

* homepage improvement

* update

* make it work

* fix

* fix

* fix links

* fix links

* documentation menu refactor

* fix baseURL

* Refactor to next (#1605)

* Add next deploy workflow

* Switch deploy branch

* Update base url

* Trigger update

* Update baseURL

* docs

* update docs

* add docs

* update

* update docs (#1657)

* update docs (#1730)

* Fix lint (#1731)

* Update docs, traffic management (#1797)

* Fix static website

* update traffic rule references (#1801)

* update v3 docs (#1835)

* update docs (#1842)

* update deploy task (#1844)

* Update build_and_deploy_next.yml

* update docs

* New homepage  (#1951)

* docsy update

* migrate from submodule to hugo module

* update workflow

* init hugo module

* try to remove Docsy setup

* revert try to remove Docsy setup

* update README.md

* fix lint errors

* doc v3 deployment (#2024)

* Modify Document (#2026)

* docs: Add more documents for extensibility filter (#2030)

* show:mse-arc (#2040)

* Add community and admin pages (#2054)

* change: home style (#2055)

* 📝 observability meter doc write (#2095)

* observability meter doc write (#2098)

* 📝 observability meter doc write

* 📝 observability meter doc write

* Update deploy

* Update htaccess

* Update java quickstart (#2176)

* Update go quickstart

* Add ecosystem files

* Update protocol

* Update apollo & nacos & zookeeper

* Update apisix & shenyu & hystrix & sentinel & seata

* Update serialization

* add development's document (#2230)

Co-authored-by: liuningbo <liuningbo.nbugs.com>

* update traffic management doc (#2231)

* Fix link

* Update download link

* remove deprecation

* Fix link

* Fix imgs

* Fix link

* Fix link

* Fix link

* Fix link

* Fix link

* Fix link

* Fix link

* Fix release

* Fix release

* Fix link

* Fix link

* Fix link

* Fix link

* Submit merge version

* Revert some changes

* Show sdk

* docs: Add more documents for extensibility router (#2296)

* Prepare for release (#2297)

* Fix release branch

* Fix always upload cache version

* Fix link

* Fix link

* Fix link

* Fix link

---------

Co-authored-by: chickenlj <ken.lj.hz@gmail.com>
Co-authored-by: mfordjody <11638005@qq.com>
Co-authored-by: Pin Xiong <pinxiong.cn@gmail.com>
Co-authored-by: kwtboom <117439825+kwtboom@users.noreply.github.com>
Co-authored-by: songxiaosheng <81170548+songxiaosheng@users.noreply.github.com>
Co-authored-by: Starfish-Ning <30331180+ningboliu@users.noreply.github.com>
  • Loading branch information
7 people authored Feb 22, 2023
1 parent ae699f6 commit 4517e8c
Show file tree
Hide file tree
Showing 772 changed files with 33,776 additions and 2,448 deletions.
1 change: 1 addition & 0 deletions .htaccess
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
RewriteRule ^(.*)$ https://cn.dubbo.apache.org/$1 [L,R=301]

RewriteCond %{SERVER_PORT} !^443$
RewriteCond %{HTTP_HOST} !static
RewriteRule ^(.*)$ https://%{HTTP_HOST}%{REQUEST_URI} [L,R=301]

RewriteCond "%{HTTP:Accept-Language}" ^zh [NC]
Expand Down
2 changes: 2 additions & 0 deletions 404.html
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@
window.location.href = newHref("docs/developers/", "contribution-guidelines/");
} else if (originalHref.indexOf("blog/index.html") >-1) {
window.location.href = newHref("blog/index.html", "blog/2018/08/07/dubbo-101/");
} else if (originalHref.indexOf("/zh/") >-1) { // hugo i18n support upgrade
window.location.href = newHref("/zh/", "/zh-cn/");
} else {
// window.location.href = "http://dubbo.apache.org/en-us/";
}
Expand Down
36 changes: 14 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,48 +7,40 @@ This project keeps all sources used for building up Dubbo official website which
## Overview

The Apache Dubbo docs are built using [Hugo](https://gohugo.io/) with the [Docsy](https://docsy.dev) theme.
This project contains the hugo project, markdown files, and theme configurations.

This project contains the markdown source files of the Dubbo documentation.

## Pre-requisites

- [Hugo extended version](https://gohugo.io/getting-started/installing)
- [Go](https://go.dev/learn/)
- [Node.js](https://nodejs.org/en/)

## Environment setup

You can directly start working on this repository even from your browser by just clicking on the following button

[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/apache/dubbo-website)

Or, you can follow the manual steps given below.

1. Ensure pre-requisites are installed
2. Clone this repository
```sh
git clone https://github.com/apache/dubbo-website.git
```
3. Change to root directory:
```sh
cd dubbo-website
```
4. Add Docsy submodule:
```sh
git submodule add https://github.com/google/docsy.git themes/docsy
```
5. Update submodules:
3. Install `PostCSS` required by Docsy by running the following commands from the root directory of your project:

```sh
git submodule update --init --recursive
$ npm install --save-dev autoprefixer
$ npm install -D postcss
$ npm install --save-dev postcss-cli
```
6. Install npm packages:

## Run server locally
1. Clear up your local module cache
```sh
npm install
hugo mod clean
```

## Run local server
1. Run
2. Start the server
```sh
hugo server --disableFastRender
```

2. Navigate to `http://localhost:1313`

## Update docs
Expand Down
Loading

0 comments on commit 4517e8c

Please sign in to comment.