| commit | 375bb435faa40499173c9ab6baa6383184c7d791 | [log] [tgz] |
|---|---|---|
| author | Craig Condit <ccondit@apache.org> | Sun Sep 11 19:04:02 2022 +1000 |
| committer | Wilfred Spiegelenburg <wilfreds@apache.org> | Sun Sep 11 19:04:02 2022 +1000 |
| tree | 9632b048fa2ea721a7e44e1819f69fb6dc1ed0dc | |
| parent | 70d64601f1d8289f8c6faf5a10f39cfa85317341 [diff] |
[YUNIKORN-1318] Change sha256sum to sha512sum in docs (#186) Closes: #186 Signed-off-by: Wilfred Spiegelenburg <wilfreds@apache.org>
This README will walk you through building and updating the Apache YuniKorn website.
The master branch contains the website source code. Modifications of the website need to be merged into the master branch.
The 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 .asf.yaml file.
You can build and run the website server locally in development mode with the following command:
./local-build.sh run
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:
./local-build.sh help
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.js the main site layout and menu definitionsrc/pages the non-versioned static pages of the sitestatic images not used in the documentationdocs the master version of the documentationsidebars.js the layout of the documentation menuThe directories versioned_docs and 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.
master branch to GitHub repo.local-build.sh buildbuild directory to a backup path outside the source tree, e.g. mkdir ../backup-site && cp -R build/* ../backup-site.asf-site branch, clear all the contents of the directory, e.g. rm -rf ./* (this leaves the files starting with a dot do not remove them!)backup-site directory back to the top-level directory of the repo, e.g. cp -R ../backup-site/* .asf-site branch to GitHub repo.The website will be updated automatically as per the normal commit flow for the asf-site branch.