Amoro Documentation Site

This repository contains the documentation for Amoro. It's built with Hugo and hosted at https://amoro.netease.com.

Structure

The Amoro documentation site is actually constructed from two hugo sites. The first, is the site page. The second site, is the documentation site which contains the full Amoro documentation. The site page and documentation sites are completely self-contained in the ./amoro-site and ./amoro-docs directories, respectively.

Relationship to the Arctic Repository

All markdown pages that are specific to an Arctic version are maintained in the Arctic repository. All pages common across all version releases are kept here in the Arctic-docs repo.

NetEase/amoro

• The docs folder in the Amoro repository contains all the markdown docs used by the versioned docs site.

NetEase/amoro-docs

• The amoro-docs/content/docs folder is the target folder when copying the docs over during a version release
• The amoro-site/content/common folder is where you can find the common markdown files shared across all versions

During each new release, the release manager will:

1. Create a branch in this repo from main named for the release version
2. Copy the contents under docs in the iceberg repo to ./amoro-docs/content/docs in the release branch
3. Update the latest branch HEAD to point to the release branch HEAD

How to Contribute

Submitting Pull Requests

Changes to the markdown contents for version specific pages should be submitted directly in the Iceberg repository.

Changes to the markdown contents for common pages should be submitted to this repository against the main branch.

Changes to the website appearance (e.g. HTML, CSS changes) should be submitted to this repository against the main branch.

Changes to the documentation of old Iceberg versions should be submitted to this repository against the specific version branch.

In summary, you can open a PR against where you find the related markdown file. With the exception of spec.md, there are no duplicate markdown files between the master branch in the iceberg repo and the main branch in the iceberg-docs repo. For changes to spec.md, PRs should be opened against the iceberg repo, not the iceberg-docs repo.

Reporting Issues

All issues related to the doc website should still be submitted to the Amoro repository. The GitHub Issues feature of this repository is disabled.

Running Locally

Clone this repository to run the website locally:

git clone [email protected]:NetEase/amoro-docs.git
cd amoro-docs

To start the site page site locally, run:

(cd amoro-site && hugo serve)

To start the documentation site locally, run:

(cd amoro-docs && hugo serve)

If you would like to see how the latest website looks based on the documentation in the Iceberg repository, you can copy docs to this repository by:

rm -rf amoro-docs/content/docs
cp -r <path to amoro repo>/docs docs/content/docs

Scanning For Broken Links

If you'd like to scan for broken links, one available tool is linkcheck that can be found here.

How the Website is Deployed

Testing Both Sites Locally

In some cases, it's useful to test both the landing-page site and the docs site locally. Especially in situations where you need to test relative links between the two sites. This can be achieved by building both sites with custom baseURL and publishDir values passed to the CLI. You can then run the site with any local live server, such as the Live Server extension for VSCode.

First, change into the amoro-site directory and build the site. Use -b and -d to set baseURL and publishDir, respectively.

cd arctic-site
hugo -b http://localhost:5500/ -d ../public

Next, change into the amoro-docs directory and do the same thing. Remember that the docs-site is deployed to a docs/<VERSION> url, relative to the landing-page site. Since the landing-page was deployed to ../publish in the example above, the example below usees ../public/docs/latest to deploy a latest version docs-site.

cd ../amoro-docs
hugo -b http://localhost:5500/docs/latest/ -d ../public/docs/latest

You should then have both sites deployed to the public directory which you can launch using your live server.

Note: The examples above use port 5500. Be sure to change the port number if your local live server uses a different port.