|author||Kuan-Po Tseng <email@example.com>||Fri Sep 15 21:26:05 2023 +0800|
|committer||GitHub <firstname.lastname@example.org>||Fri Sep 15 21:26:05 2023 +0800|
[YUNIKORN-1970] Fix outdated metrics document (#335)
This README will walk you through building and updating the Apache YuniKorn website.
master branch contains the website source code. Modifications of the website need to be merged into the master branch.
asf-site branch contains the deployed static pages, scripts and images of the website. This branch is maintained by
yunikorn-bot. Manually updating this branch should only happen as a last resort.
The website running at https://yunikorn.apache.org will be updated automatically via the configuration set in the
You can build and run the website server locally in development mode with the following command:
This command will build a Docker image
yunikorn/yunikorn-website:latest locally, and launch the web-server at this URL: http://localhost:3000 The website will be built based on the content in the current directory. Any changes that are made within the directory will automatically trigger the update of the local webserver. You can review your changes from the local endpoint to verify your changes. Once the development is done, you need to press
Control+C to exit the script mode.
For an overview of all options of the local build script run:
Instead of running the build inside a docker image you can also run it locally when you have yarn installed. This is faster than running the build inside a Docker image:
yarn install yarn add @docusaurus/theme-search-algolia yarn build
Run the website server locally in development mode with the following command:
yarn install yarn add @docusaurus/theme-search-algolia yarn run start
The website is built based using docusaurus-v2. The pages and documentation are written in MD file format, the data required is located at:
docusaurus.config.jsthe main site layout and menu definition
src/pagesthe non-versioned static pages of the site
staticimages not used in the documentation
docsthe master version of the documentation
sidebars.jsthe layout of the documentation menu
versioned_sidebars contain the versioned copies of the documentation and the layout. Documentation versioning is part of the release procedure. Updates to all current documentation follows the standard JIRA and pull request model.
For advanced updates, including style, theme, etc, please refer to the docusaurus documentation. Changes in this area should be discussed before applying.
Static pages form a small but crucial part of the site. The following pages are part of the static content:
The top menu is defined in the
docusaurus.config.js. New pages that are added which need to be accessible from the menu must be added to the configuration. Pages that are linked from other pages do not require a configuration entry.
The Apache links are only defined as part of the site layout and are not backed by any pages.
The deployment should happen automatically once all changes are merged into the master branch. It usually takes a few minutes before the asf site gets updated.
Note: In most of the cases, you do not need to read this section as publishing should be handled by the github workflow.
All the below steps expect that the current directory is the top-level directory of the repository.
masterbranch to GitHub repo.
builddirectory to a backup path outside the source tree, e.g.
mkdir ../backup-site && cp -R build/* ../backup-site.
asf-sitebranch, clear all the contents of the directory, e.g.
rm -rf ./*(this leaves the files starting with a dot do not remove them!)
backup-sitedirectory back to the top-level directory of the repo, e.g.
cp -R ../backup-site/* .
asf-sitebranch to GitHub repo.
The website will be updated automatically as per the normal commit flow for the